From 7093df1ccef0d9364a4bf16bd54cb4d3ea3c838c Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Mon, 22 Jul 2024 03:40:05 -0500 Subject: [PATCH 01/22] add initial comments for expanding Quota api --- cloudstack/QuotaService.go | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index 9adfe6c..d01eacd 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -25,8 +25,17 @@ import ( ) type QuotaServiceIface interface { + //CreateBalance(p *CreateBalanceParams) (*CreateBalanceResponse, error) + //CreateCredit(p *CreateCreditParams) (*CreateCreditResponse, error) QuotaIsEnabled(p *QuotaIsEnabledParams) (*QuotaIsEnabledResponse, error) NewQuotaIsEnabledParams() *QuotaIsEnabledParams + //CreateStatement(p *CreateStatementParams) (*CreateStatementResponse, error) + //ListSummary(p *GetSummaryParams) (*GetSummaryResponse, error) + //CreateTariff(p *CreateTariffParams) (*CreateTariffResponse, error) + //DeleteTariff(p *DeleteTariffParams) (*DeleteTariffResponse, error) + //ListTariffs(p *ListTariffsParams) (*ListTariffsResponse, error) + //UpdateTariff(p *UpdateTariffParams) (*UpdateTariffResponse, error) + //UpdateQuota(p *UpdateQuotaParams) (*UpdateQuotaResponse, error) } type QuotaIsEnabledParams struct { From 13e95e3f9b0dfe42aff61154bbee37b835ec5db8 Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Mon, 22 Jul 2024 04:12:14 -0500 Subject: [PATCH 02/22] implement QuotaBalance --- cloudstack/QuotaService.go | 174 ++++++++++++++++++++++++++++++++++++- 1 file changed, 173 insertions(+), 1 deletion(-) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index d01eacd..d242291 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -25,7 +25,8 @@ import ( ) type QuotaServiceIface interface { - //CreateBalance(p *CreateBalanceParams) (*CreateBalanceResponse, error) + QuotaBalance(p *QuotaBalanceParams) (*QuotaBalanceResponse, error) + NewQuotaBalanceParams(account string, domainid string) *QuotaBalanceParams //CreateCredit(p *CreateCreditParams) (*CreateCreditResponse, error) QuotaIsEnabled(p *QuotaIsEnabledParams) (*QuotaIsEnabledResponse, error) NewQuotaIsEnabledParams() *QuotaIsEnabledParams @@ -38,6 +39,177 @@ type QuotaServiceIface interface { //UpdateQuota(p *UpdateQuotaParams) (*UpdateQuotaResponse, error) } +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["domainid"]; found { + u.Set("domainid", v.(string)) + } + if v, found := p.p["accountid"]; found { + u.Set("accountid", 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 = make(map[string]interface{}) + } + 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) 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 = make(map[string]interface{}) + } + 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) 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 = make(map[string]interface{}) + } + 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) 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 = make(map[string]interface{}) + } + 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 = make(map[string]interface{}) + } + 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 +} + +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 { + Account string `json:"account"` + Accountid string `json:"accountid"` + Domain string `json:"domain"` + Name string `json:"name"` + Quota string `json:"quota"` + Type string `json:"type"` + Unit string `json:"unit"` +} + type QuotaIsEnabledParams struct { p map[string]interface{} } From e33792dccef55668267a8b2390d6a12089175234 Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Mon, 22 Jul 2024 04:21:31 -0500 Subject: [PATCH 03/22] implement QuotaCredits --- cloudstack/QuotaService.go | 175 ++++++++++++++++++++++++++++++++++++- 1 file changed, 173 insertions(+), 2 deletions(-) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index d242291..c3b0509 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -26,8 +26,9 @@ import ( type QuotaServiceIface interface { QuotaBalance(p *QuotaBalanceParams) (*QuotaBalanceResponse, error) - NewQuotaBalanceParams(account string, domainid string) *QuotaBalanceParams - //CreateCredit(p *CreateCreditParams) (*CreateCreditResponse, error) + NewQuotaBalanceParams(account, domainid string) *QuotaBalanceParams + QuotaCredits(p *QuotaCreditsParams) (*QuotaCreditsParams, error) + NewQuotaCreditsParams(account, domainid, value string) *QuotaCreditsParams QuotaIsEnabled(p *QuotaIsEnabledParams) (*QuotaIsEnabledResponse, error) NewQuotaIsEnabledParams() *QuotaIsEnabledParams //CreateStatement(p *CreateStatementParams) (*CreateStatementResponse, error) @@ -210,6 +211,176 @@ type QuotaBalanceResponse struct { Unit string `json:"unit"` } +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["value"]; found { + u.Set("value", v.(string)) + } + if v, found := p.p["min_balance"]; found { + u.Set("min_balance", v.(string)) + + } + if v, found := p.p["quota_enforce"]; found { + u.Set("quota_enforce", v.(string)) + } + 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 = make(map[string]interface{}) + } + 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 = make(map[string]interface{}) + } + 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) SetValue(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["value"] = v +} + +func (p *QuotaCreditsParams) ResetValue() { + if p.p == nil { + p.p = make(map[string]interface{}) + } + delete(p.p, "value") +} + +func (p *QuotaCreditsParams) GetValue() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["value"].(string) + return value, ok +} + +func (p *QuotaCreditsParams) SetMinBalance(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["min_balance"] = v +} + +func (p *QuotaCreditsParams) ResetMinBalance() { + if p.p == nil { + p.p = make(map[string]interface{}) + } + delete(p.p, "min_balance") +} + +func (p *QuotaCreditsParams) GetMinBalance() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["min_balance"].(string) + return value, ok +} + +func (p *QuotaCreditsParams) SetQuotaEnforce(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["quota_enforce"] = v +} + +func (p *QuotaCreditsParams) ResetQuotaEnforce() { + if p.p == nil { + p.p = make(map[string]interface{}) + } + delete(p.p, "quota_enforce") +} + +func (p *QuotaCreditsParams) GetQuotaEnforce() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["quota_enforce"].(string) + 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, domainid, value string) *QuotaCreditsParams { + p := &QuotaCreditsParams{} + p.p = make(map[string]interface{}) + p.p["account"] = account + p.p["domainid"] = domainid + p.p["value"] = value + return p +} + +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 string `json:"credits"` + Currency string `json:"currency"` + Updated_by string `json:"updated_by"` + Updated_on string `json:"updated_on"` +} + type QuotaIsEnabledParams struct { p map[string]interface{} } From 3b9631838536a5cdbb98b0a90134514430935baa Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Mon, 22 Jul 2024 04:27:57 -0500 Subject: [PATCH 04/22] implement QuotaStatement --- cloudstack/QuotaService.go | 200 +++++++++++++++++++++++++++++++++++++ 1 file changed, 200 insertions(+) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index c3b0509..e282133 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -31,6 +31,8 @@ type QuotaServiceIface interface { NewQuotaCreditsParams(account, domainid, value string) *QuotaCreditsParams QuotaIsEnabled(p *QuotaIsEnabledParams) (*QuotaIsEnabledResponse, error) NewQuotaIsEnabledParams() *QuotaIsEnabledParams + QuotaStatement(p *QuotaStatementParams) (*QuotaStatementResponse, error) + NewQuotaStatementParams(account, domainid, enddate, startdate string) *QuotaStatementParams //CreateStatement(p *CreateStatementParams) (*CreateStatementResponse, error) //ListSummary(p *GetSummaryParams) (*GetSummaryResponse, error) //CreateTariff(p *CreateTariffParams) (*CreateTariffResponse, error) @@ -421,3 +423,201 @@ 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["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["accountid"]; found { + u.Set("accountid", v.(string)) + } + if v, found := p.p["type"]; found { + u.Set("type", v.(string)) + } + 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 = make(map[string]interface{}) + } + 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) 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 = make(map[string]interface{}) + } + 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 = make(map[string]interface{}) + } + 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 = make(map[string]interface{}) + } + 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) 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 = make(map[string]interface{}) + } + 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) SetType(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["type"] = v +} + +func (p *QuotaStatementParams) ResetType() { + if p.p == nil { + p.p = make(map[string]interface{}) + } + delete(p.p, "type") +} + +func (p *QuotaStatementParams) GetType() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["type"].(string) + 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, domainid, enddate, 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 +} + +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 { + Account string `json:"account"` + Accountid string `json:"accountid"` + Domain string `json:"domain"` + Name string `json:"name"` + Quota string `json:"quota"` + Type string `json:"type"` + Unit string `json:"unit"` +} From ff5c4ff568fa07a141cbb36da992d8935eb16fb9 Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Mon, 22 Jul 2024 04:37:40 -0500 Subject: [PATCH 05/22] implement QuotaSummary --- cloudstack/QuotaService.go | 203 +++++++++++++++++++++++++++++++++++++ 1 file changed, 203 insertions(+) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index e282133..03d2e9c 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -22,6 +22,7 @@ package cloudstack import ( "encoding/json" "net/url" + "strconv" ) type QuotaServiceIface interface { @@ -33,6 +34,8 @@ type QuotaServiceIface interface { NewQuotaIsEnabledParams() *QuotaIsEnabledParams QuotaStatement(p *QuotaStatementParams) (*QuotaStatementResponse, error) NewQuotaStatementParams(account, domainid, enddate, startdate string) *QuotaStatementParams + QuotaSummary(p *QuotaSummaryParams) (*QuotaSummaryResponse, error) + NewQuotaSummaryParams() *QuotaSummaryParams //CreateStatement(p *CreateStatementParams) (*CreateStatementResponse, error) //ListSummary(p *GetSummaryParams) (*GetSummaryResponse, error) //CreateTariff(p *CreateTariffParams) (*CreateTariffResponse, error) @@ -621,3 +624,203 @@ type QuotaStatementResponse struct { Type string `json:"type"` Unit string `json:"unit"` } + +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 { + u.Add("listall", 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) + } + 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 = make(map[string]interface{}) + } + 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 = make(map[string]interface{}) + } + 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 = make(map[string]interface{}) + } + 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 string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["listall"] = v +} + +func (p *QuotaSummaryParams) ResetListall() { + if p.p == nil { + p.p = make(map[string]interface{}) + } + delete(p.p, "listall") +} + +func (p *QuotaSummaryParams) GetListall() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["listall"].(string) + 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 = make(map[string]interface{}) + } + 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 = make(map[string]interface{}) + } + 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 +} + +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 { + Account string `json:"account"` + Accountid string `json:"accountid"` + Balance string `json:"balance"` + Currency string `json:"currency"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Enddate string `json:"enddate"` + Quota string `json:"quota"` + Quotaenabled string `json:"quotaenabled"` + Startdate string `json:"startdate"` + State string `json:"state"` +} From 47aa8a5bce1477c61264572b30b1dcdd66d29111 Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Mon, 22 Jul 2024 18:08:35 -0500 Subject: [PATCH 06/22] implement QuotaTariffCreate --- cloudstack/QuotaService.go | 231 +++++++++++++++++++++++++++++++++++++ 1 file changed, 231 insertions(+) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index 03d2e9c..e06c328 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -36,6 +36,8 @@ type QuotaServiceIface interface { NewQuotaStatementParams(account, domainid, enddate, startdate string) *QuotaStatementParams QuotaSummary(p *QuotaSummaryParams) (*QuotaSummaryResponse, error) NewQuotaSummaryParams() *QuotaSummaryParams + QuotaTariffCreate(p *QuotaTariffCreateParams) (*QuotaTariffCreateResponse, error) + NewQuotaTariffCreateParams(name, usagetype, value string) *QuotaTariffCreateParams //CreateStatement(p *CreateStatementParams) (*CreateStatementResponse, error) //ListSummary(p *GetSummaryParams) (*GetSummaryResponse, error) //CreateTariff(p *CreateTariffParams) (*CreateTariffResponse, error) @@ -824,3 +826,232 @@ type QuotaSummaryResponse struct { 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["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["usagetype"]; found { + u.Set("usagetype", v.(string)) + } + if v, found := p.p["value"]; found { + u.Set("value", v.(string)) + } + 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["startdate"]; found { + u.Set("startdate", v.(string)) + } + return u +} + +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 = make(map[string]interface{}) + } + 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) SetUsagetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["usagetype"] = v +} + +func (p *QuotaTariffCreateParams) ResetUsagetype() { + if p.p == nil { + p.p = make(map[string]interface{}) + } + delete(p.p, "usagetype") +} + +func (p *QuotaTariffCreateParams) GetUsagetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["usagetype"].(string) + return value, ok +} + +func (p *QuotaTariffCreateParams) SetValue(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["value"] = v +} + +func (p *QuotaTariffCreateParams) ResetValue() { + if p.p == nil { + p.p = make(map[string]interface{}) + } + delete(p.p, "value") +} + +func (p *QuotaTariffCreateParams) GetValue() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["value"].(string) + return value, ok +} + +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 = make(map[string]interface{}) + } + 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 = make(map[string]interface{}) + } + 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 = make(map[string]interface{}) + } + 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) 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 = make(map[string]interface{}) + } + 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 +} + +// 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, usagetype, value string) *QuotaTariffCreateParams { + p := &QuotaTariffCreateParams{} + p.p = make(map[string]interface{}) + p.p["name"] = name + p.p["usagetype"] = usagetype + p.p["value"] = value + return p +} + +func (s *QuotaService) QuotaTariffCreate(p *QuotaTariffCreateParams) (*QuotaTariffCreateResponse, error) { + resp, err := s.cs.newRequest("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"` + Name string `json:"name"` + Removed string `json:"removed"` + TariffValue string `json:"tariffValue"` + UsageDiscriminator string `json:"usageDiscriminator"` + UsageName string `json:"usageName"` + UsageType string `json:"usageType"` + UsageTypeDescription string `json:"usageTypeDescription"` + UsageUnit string `json:"usageUnit"` + Uuid string `json:"uuid"` +} From cc738ece0ef0af5d57a32728c33f4c5d710f69b1 Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Mon, 22 Jul 2024 18:11:20 -0500 Subject: [PATCH 07/22] implement QuotaTariffDelete --- cloudstack/QuotaService.go | 74 ++++++++++++++++++++++++++++++++++---- 1 file changed, 67 insertions(+), 7 deletions(-) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index e06c328..ca2f0c0 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -38,13 +38,8 @@ type QuotaServiceIface interface { NewQuotaSummaryParams() *QuotaSummaryParams QuotaTariffCreate(p *QuotaTariffCreateParams) (*QuotaTariffCreateResponse, error) NewQuotaTariffCreateParams(name, usagetype, value string) *QuotaTariffCreateParams - //CreateStatement(p *CreateStatementParams) (*CreateStatementResponse, error) - //ListSummary(p *GetSummaryParams) (*GetSummaryResponse, error) - //CreateTariff(p *CreateTariffParams) (*CreateTariffResponse, error) - //DeleteTariff(p *DeleteTariffParams) (*DeleteTariffResponse, error) - //ListTariffs(p *ListTariffsParams) (*ListTariffsResponse, error) - //UpdateTariff(p *UpdateTariffParams) (*UpdateTariffResponse, error) - //UpdateQuota(p *UpdateQuotaParams) (*UpdateQuotaResponse, error) + QuotaTariffDelete(p *QuotaTariffDeleteParams) (*QuotaTariffDeleteResponse, error) + NewQuotaTariffDeleteParams(id string) *QuotaTariffDeleteParams } type QuotaBalanceParams struct { @@ -1055,3 +1050,68 @@ type QuotaTariffCreateResponse struct { UsageUnit string `json:"usageUnit"` Uuid string `json:"uuid"` } + +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 = make(map[string]interface{}) + } + 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 +} + +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"` + Success bool `json:"success"` +} From 7621f72f41c855a973e787ae03a6d4b9696ec1f3 Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Mon, 22 Jul 2024 18:13:28 -0500 Subject: [PATCH 08/22] implement QuotaTariffList --- cloudstack/QuotaService.go | 53 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index ca2f0c0..c4c0229 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -40,6 +40,8 @@ type QuotaServiceIface interface { NewQuotaTariffCreateParams(name, usagetype, value string) *QuotaTariffCreateParams QuotaTariffDelete(p *QuotaTariffDeleteParams) (*QuotaTariffDeleteResponse, error) NewQuotaTariffDeleteParams(id string) *QuotaTariffDeleteParams + QuotaTariffList(p *QuotaTariffListParams) (*QuotaTariffListResponse, error) + NewQuotaTariffListParams() *QuotaTariffListParams } type QuotaBalanceParams struct { @@ -1115,3 +1117,54 @@ type QuotaTariffDeleteResponse struct { DisplayText string `json:"displaytext"` Success bool `json:"success"` } + +type QuotaTariffListParams struct { + p map[string]interface{} +} + +func (p *QuotaTariffListParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + return u +} + +// 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 +} + +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 { + Activationrule string `json:"activationRule"` + Currency string `json:"currency"` + Description string `json:"description"` + EffectiveDate string `json:"effectiveDate"` + EndDate string `json:"endDate"` + Name string `json:"name"` + Removed string `json:"removed"` + TariffValue string `json:"tariffValue"` + UsageDiscriminator string `json:"usageDiscriminator"` + UsageName string `json:"usageName"` + UsageType string `json:"usageType"` + UsageTypeDescription string `json:"usageTypeDescription"` + UsageUnit string `json:"usageUnit"` + Uuid string `json:"uuid"` +} From 8c8684272429bda79df33af6b6bdf88a33e09449 Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Mon, 22 Jul 2024 18:26:35 -0500 Subject: [PATCH 09/22] implemented QuotaTariffUpdate --- cloudstack/QuotaService.go | 230 +++++++++++++++++++++++++++++++++++++ 1 file changed, 230 insertions(+) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index c4c0229..526d3e5 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -42,6 +42,8 @@ type QuotaServiceIface interface { NewQuotaTariffDeleteParams(id string) *QuotaTariffDeleteParams QuotaTariffList(p *QuotaTariffListParams) (*QuotaTariffListResponse, error) NewQuotaTariffListParams() *QuotaTariffListParams + QuotaTariffUpdate(p *QuotaTariffUpdateParams) (*QuotaTariffUpdateResponse, error) + NewQuotaTariffUpdateParams(name string) *QuotaTariffUpdateParams } type QuotaBalanceParams struct { @@ -1168,3 +1170,231 @@ type QuotaTariffListResponse struct { UsageUnit string `json:"usageUnit"` Uuid string `json:"uuid"` } + +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["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["activationrule"]; found { + u.Set("activationrule", v.(string)) + } + if v, found := p.p["usagetype"]; found { + u.Set("usagetype", v.(string)) + } + if v, found := p.p["value"]; found { + u.Set("value", 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["startdate"]; found { + u.Set("startdate", v.(string)) + } + return u +} + +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 = make(map[string]interface{}) + } + 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) 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 = make(map[string]interface{}) + } + 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 = make(map[string]interface{}) + } + 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() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["enddate"].(string) + return value, ok +} + +func (p *QuotaTariffUpdateParams) ResetEnddate() { + if p.p == nil { + p.p = make(map[string]interface{}) + } + 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) 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 = make(map[string]interface{}) + } + 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 string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["usagetype"] = v +} + +func (p *QuotaTariffUpdateParams) ResetUsagetype() { + if p.p == nil { + p.p = make(map[string]interface{}) + } + delete(p.p, "usagetype") +} + +func (p *QuotaTariffUpdateParams) GetUsagetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["usagetype"].(string) + return value, ok +} + +func (p *QuotaTariffUpdateParams) SetValue(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["value"] = v +} + +func (p *QuotaTariffUpdateParams) ResetValue() { + if p.p == nil { + p.p = make(map[string]interface{}) + } + delete(p.p, "value") +} + +func (p *QuotaTariffUpdateParams) GetValue() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["value"].(string) + 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 +} + +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"` + Name string `json:"name"` + Removed string `json:"removed"` + TariffValue string `json:"tariffValue"` + UsageDiscriminator string `json:"usageDiscriminator"` + UsageName string `json:"usageName"` + UsageType string `json:"usageType"` + UsageTypeDescription string `json:"usageTypeDescription"` + UsageUnit string `json:"usageUnit"` + Uuid string `json:"uuid"` +} From 4350a48ecc6f580c0424c12a0f350f995c4f601e Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Mon, 22 Jul 2024 18:30:32 -0500 Subject: [PATCH 10/22] implemented QuotaUpdate --- cloudstack/QuotaService.go | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index 526d3e5..bc910a8 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -44,6 +44,7 @@ type QuotaServiceIface interface { NewQuotaTariffListParams() *QuotaTariffListParams QuotaTariffUpdate(p *QuotaTariffUpdateParams) (*QuotaTariffUpdateResponse, error) NewQuotaTariffUpdateParams(name string) *QuotaTariffUpdateParams + QuotaUpdate() (*QuotaUpdateResponse, error) } type QuotaBalanceParams struct { @@ -1398,3 +1399,21 @@ type QuotaTariffUpdateResponse struct { UsageUnit string `json:"usageUnit"` Uuid string `json:"uuid"` } + +func (s *QuotaService) QuotaUpdate() (*QuotaUpdateResponse, error) { + resp, err := s.cs.newRequest("quotaUpdate") + 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 { + UpdatedOn string `json:"updated_on"` +} From 53aece7bd122d0042ec42241e26bae7ed96fff92 Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Mon, 22 Jul 2024 18:31:03 -0500 Subject: [PATCH 11/22] fix url values --- cloudstack/QuotaService.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index bc910a8..ee35453 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -1401,7 +1401,7 @@ type QuotaTariffUpdateResponse struct { } func (s *QuotaService) QuotaUpdate() (*QuotaUpdateResponse, error) { - resp, err := s.cs.newRequest("quotaUpdate") + resp, err := s.cs.newRequest("quotaUpdate", nil) if err != nil { return nil, err } From 9ab6946a232076634d73980b8cbf8484c6cb2eef Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Mon, 22 Jul 2024 18:35:19 -0500 Subject: [PATCH 12/22] add NewQuotaUpdateParams for QuotaUpdate --- cloudstack/QuotaService.go | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index ee35453..7f28459 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -45,6 +45,7 @@ type QuotaServiceIface interface { QuotaTariffUpdate(p *QuotaTariffUpdateParams) (*QuotaTariffUpdateResponse, error) NewQuotaTariffUpdateParams(name string) *QuotaTariffUpdateParams QuotaUpdate() (*QuotaUpdateResponse, error) + NewQuotaUpdateParams() *QuotaUpdateParams } type QuotaBalanceParams struct { @@ -1400,6 +1401,18 @@ type QuotaTariffUpdateResponse struct { Uuid string `json:"uuid"` } +type QuotaUpdateParams struct { + p map[string]interface{} +} + +// 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 +} + func (s *QuotaService) QuotaUpdate() (*QuotaUpdateResponse, error) { resp, err := s.cs.newRequest("quotaUpdate", nil) if err != nil { From 5d075fb8a8521cafa1e6f8e636418ba70382049e Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Tue, 23 Jul 2024 20:28:54 -0500 Subject: [PATCH 13/22] updated listApis.json with latest 4.19.2 from cloudmonkey cli --- generate/listApis.json | 131804 +++++++++++++++++++------------------- 1 file changed, 66422 insertions(+), 65382 deletions(-) diff --git a/generate/listApis.json b/generate/listApis.json index bbc5c76..2f0a9f1 100644 --- a/generate/listApis.json +++ b/generate/listApis.json @@ -22,6 +22,17 @@ ], "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": "id of the resource", "name": "resourceid", @@ -32,23 +43,12 @@ "name": "base64image", "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "resourceobjecttype" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.16.0.0" }, @@ -58,19 +58,34 @@ "name": "createVPCOffering", "params": [ { - "description": "the display text of the vpc offering, defaults to the 'name'", + "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": "displaytext", + "name": "internetprotocol", "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "desired service capabilities as part of vpc offering", + "description": "set to true if the offering is to be enabled during creation. Default is false", "length": 255, - "name": "servicecapabilitylist", + "name": "enable", "required": false, - "since": "4.4", - "type": "map" + "since": "4.16", + "type": "boolean" + }, + { + "description": "services supported by the vpc offering", + "length": 255, + "name": "supportedservices", + "required": true, + "type": "list" + }, + { + "description": "the name of the vpc offering", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", @@ -88,21 +103,6 @@ "since": "4.13", "type": "list" }, - { - "description": "the name of the vpc offering", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "set to true if the offering is to be enabled during creation. Default is false", - "length": 255, - "name": "enable", - "required": false, - "since": "4.16", - "type": "boolean" - }, { "description": "the ID of the containing domain(s), null for public offerings", "length": 255, @@ -112,11 +112,10 @@ "type": "list" }, { - "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6", + "description": "the display text of the vpc offering, defaults to the 'name'", "length": 255, - "name": "internetprotocol", + "name": "displaytext", "required": false, - "since": "4.17.0", "type": "string" }, { @@ -128,18 +127,54 @@ "type": "uuid" }, { - "description": "services supported by the vpc offering", + "description": "desired service capabilities as part of vpc offering", "length": 255, - "name": "supportedservices", - "required": true, - "type": "list" + "name": "servicecapabilitylist", + "required": false, + "since": "4.4", + "type": "map" } ], "related": "updateVPCOffering,listVPCOfferings", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" + }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, + { + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { @@ -156,13 +191,13 @@ "name": "capability", "response": [ { - "description": "the capability value", - "name": "value", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "the capability name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" }, { @@ -173,23 +208,13 @@ ], "type": "list" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { @@ -198,98 +223,73 @@ "type": "string" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { "description": "services for this provider", "name": "servicelist", "type": "list" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "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": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" - }, - { - "description": "the 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 id of the vpc offering", "name": "id", "type": "string" }, + {}, { "description": "the name of the vpc offering", "name": "name", "type": "string" }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" - }, - { - "description": "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": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { "description": " indicated if the offering can support region level vpc", "name": "supportsregionLevelvpc", "type": "boolean" }, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -298,27 +298,33 @@ "name": "createPod", "params": [ { - "description": "the ending IP address for the Pod", + "description": "the starting IP address for the Pod", "length": 255, - "name": "endip", + "name": "startip", "required": false, "type": "string" }, { - "description": "the Zone ID in which the Pod will be created", + "description": "the gateway for the Pod", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "gateway", + "required": false, + "type": "string" }, { - "description": "the starting IP address for the Pod", + "description": "Allocation state of this Pod for allocation of new resources", "length": 255, - "name": "startip", + "name": "allocationstate", "required": false, "type": "string" }, + { + "description": "the name of the Pod", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "the netmask for the Pod", "length": 255, @@ -327,71 +333,138 @@ "type": "string" }, { - "description": "the gateway for the Pod", + "description": "the Zone ID in which the Pod will be created", "length": 255, - "name": "gateway", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the ending IP address for the Pod", + "length": 255, + "name": "endip", "required": false, "type": "string" + } + ], + "related": "listPods,updatePod,createManagementNetworkIpRange", + "response": [ + { + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" }, { - "description": "Allocation state of this Pod for allocation of new resources", - "length": 255, + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + }, + { + "description": "the allocation state of the Pod", "name": "allocationstate", - "required": false, "type": "string" }, { "description": "the name of the Pod", - "length": 255, "name": "name", - "required": true, "type": "string" - } - ], - "related": "listPods,updatePod,createManagementNetworkIpRange", - "response": [ + }, { - "description": "the capacity of the Pod", - "name": "capacity", + "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": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" + }, + {}, + { + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", "response": [ { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the ending IP for the range", + "name": "endip", + "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ + { + "description": "the Cluster name", + "name": "clustername", "type": "string" }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, { "description": "the capacity currently in allocated", "name": "capacityallocated", "type": "long" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { @@ -399,19 +472,29 @@ "name": "name", "type": "string" }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, { "description": "the capacity currently in use", "name": "capacityused", "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Pod name", + "name": "podname", "type": "string" } ], @@ -427,105 +510,22 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" - }, - { - "description": "the ID of the Pod", - "name": "id", - "type": "string" - }, { "description": "the gateway of the Pod", "name": "gateway", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the netmask of the Pod", "name": "netmask", "type": "string" }, + {}, { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - }, - { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" - }, - { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" - }, - { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the name of the Pod", - "name": "name", - "type": "string" - }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, - { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - } - ], + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", "type": "list" - }, - {}, - {} + } ] }, { @@ -533,6 +533,14 @@ "isasync": false, "name": "ldapCreateAccount", "params": [ + { + "description": "Creates the account under the specified role.", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": false, + "type": "uuid" + }, { "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, @@ -541,26 +549,26 @@ "type": "string" }, { - "description": "Account UUID, required for adding account from external provisioning system", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "accountid", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Network domain for the account's networks", + "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": "networkdomain", + "name": "account", "required": false, "type": "string" }, { - "description": "Creates the account under the specified role.", + "description": "Network domain for the account's networks", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "networkdomain", "required": false, - "type": "uuid" + "type": "string" }, { "description": "details for account used to store specific parameters", @@ -569,13 +577,6 @@ "required": false, "type": "map" }, - { - "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": "Unique username.", "length": 255, @@ -584,19 +585,18 @@ "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": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "account", + "name": "accounttype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Creates the user under the specified domain.", + "description": "Account UUID, required for adding account from external provisioning system", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "accountid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "User UUID, required for adding account from external provisioning system", @@ -608,41 +608,25 @@ ], "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ - {}, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the id of the account", + "name": "id", + "type": "string" }, { "description": "the total secondary storage space (in GiB) the account can own", @@ -650,284 +634,150 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the id of the account", - "name": "id", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { "description": "id of the Domain the account belongs to", "name": "domainid", "type": "string" }, - {}, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, + {}, { "description": "the total memory (in MB) the account can own", "name": "memorylimit", "type": "string" }, + {}, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "the name of the account", - "name": "name", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, { "description": "the state of the account", "name": "state", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" - }, - { - "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 account", "name": "projecttotal", "type": "long" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { "description": "the list of users associated with account", "name": "user", "response": [ - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, { "description": "the date and time the user account was created", "name": "created", "type": "date" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "the name of the role", @@ -935,18 +785,18 @@ "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the user name", + "name": "username", "type": "string" }, { @@ -954,49 +804,39 @@ "name": "account", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, { "description": "the domain name of the user", "name": "domain", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the api key of the user", + "name": "apikey", + "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { @@ -1005,151 +845,335 @@ "type": "boolean" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the ID of the role", + "name": "roleid", "type": "string" } ], "type": "list" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "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": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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 snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ], - "since": "4.6.0" - }, - { - "description": "Copies an iso from one zone to another.", - "isasync": true, - "name": "copyIso", - "params": [ - { - "description": "ID of the zone the template is being copied to.", - "length": 255, - "name": "destzoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "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" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "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 number of projects the account can own", + "name": "projectlimit", + "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" - } - ], - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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": "the name of userdata linked to this template", - "name": "userdataname", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, - {}, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "Safely removes raw records from cloud_usage table", + "isasync": false, + "name": "removeRawUsageRecords", + "params": [ + { + "description": "Specify the number of days (greater than zero) to remove records that are older than those number of days from today. For example, specifying 10 would result in removing all the records created before 10 days from today", + "length": 255, + "name": "interval", + "required": true, + "type": "integer" + } + ], + "response": [ + { + "description": "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.6.0" + }, + { + "description": "Copies an iso from one zone to another.", + "isasync": true, + "name": "copyIso", + "params": [ + { + "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" + }, + { + "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": "ID of the zone the template is being copied to.", + "length": 255, + "name": "destzoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "length": 255, + "name": "destzoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "list" + } + ], + "related": "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 ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, { "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", "name": "directdownload", "type": "boolean" }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", @@ -1160,8 +1184,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -1170,8 +1194,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -1180,8 +1204,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -1190,13 +1214,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -1208,29 +1232,29 @@ "type": "set" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { "description": "true if this template is a public template, false otherwise", @@ -1238,24 +1262,24 @@ "type": "boolean" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "true if template requires HVM enabled, false otherwise", @@ -1263,49 +1287,51 @@ "type": "boolean" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the template 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": "checksum of the template", + "name": "checksum", + "type": "string" }, { "description": "VMware only: additional key/value details tied with deploy-as-is template", @@ -1313,33 +1339,38 @@ "type": "map" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { @@ -1348,101 +1379,109 @@ "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the template display text", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, - {}, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the template ID", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + } + ] + }, + { + "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": "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", + "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "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": "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" - } + {} ] }, { @@ -1454,89 +1493,50 @@ "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", "length": 255, "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "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": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, - "name": "reconnect", + "name": "provider", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "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": "provider", + "name": "reconnect", "required": false, - "type": "string" + "type": "boolean" } ], "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {} - ], - "since": "4.11.0" - }, - { - "description": "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } - ] + ], + "since": "4.11.0" }, { "description": "Lists VM metrics", @@ -1544,34 +1544,35 @@ "name": "listVirtualMachinesMetrics", "params": [ { - "description": "list vms by iso", + "description": "the group ID", "length": 255, - "name": "isoid", + "name": "groupid", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "accumulate", "required": false, - "type": "uuid" + "since": "4.17.0", + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "account", + "name": "haenable", "required": false, - "type": "string" + "since": "4.15", + "type": "boolean" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "List by keyword", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the user ID that created the VM and is under the account that owns the VM", @@ -1582,250 +1583,257 @@ "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "displayvm", + "name": "ids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, "since": "4.4", - "type": "boolean" + "type": "list" }, { - "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": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "description": "the host ID", "length": 255, - "name": "userdata", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "type": "uuid" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "the security group ID", "length": 255, - "name": "ids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "securitygroupid", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, - "since": "4.4", - "type": "list" + "since": "4.15", + "type": "uuid" }, { - "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", + "description": "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": "details", + "name": "isvnf", "required": false, - "type": "list" + "since": "4.19.0", + "type": "boolean" }, { - "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isvnf", + "name": "displayvm", "required": false, - "since": "4.19.0", + "since": "4.4", "type": "boolean" }, { - "description": "list by the backup offering", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "backupofferingid", + "name": "tags", "required": false, - "since": "4.17", - "type": "uuid" + "type": "map" }, { - "description": "list vms by template", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", "length": 255, - "name": "listall", + "name": "userdata", "required": false, + "since": "4.18.0.0", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" + }, + { + "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": "flag to display the resource icon for VMs", + "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", "length": 255, - "name": "showicon", + "name": "details", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "type": "list" }, { - "description": "the security group ID", + "description": "list vms by iso", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "isoid", "required": false, - "since": "4.15", "type": "uuid" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "list vms by vpc", "length": 255, - "name": "forvirtualnetwork", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "the target hypervisor for the template", "length": 255, - "name": "page", + "name": "hypervisor", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the group ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "groupid", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the ID of the virtual machine", "length": 255, - "name": "tags", + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the host ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "", + "description": "the cluster ID", "length": 255, - "name": "pagesize", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "description": "list vms by ssh keypair name", "length": 255, - "name": "state", + "name": "keypair", "required": false, "type": "string" }, { - "description": "list vms by vpc", + "description": "list vms by template", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "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 ID of the virtual machine", + "description": "list by the backup offering", "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "backupofferingid", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "list vms by ssh keypair name", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "keypair", + "name": "autoscalevmgroupid", + "related": "createAutoScaleVmGroup,disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "required": false, - "type": "string" + "since": "4.18.0", + "type": "uuid" }, { - "description": "the target hypervisor for the template", + "description": "the pod ID", "length": 255, - "name": "hypervisor", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "makes the API's response contains only the resource count", + "description": "", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the cluster ID", + "description": "list vms by affinity group", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, "type": "uuid" }, { - "description": "the availability zone ID", + "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of AutoScaling VM Group", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "autoscalevmgroupid", - "related": "createAutoScaleVmGroup,disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "name": "storageid", + "related": "listVsphereStoragePolicyCompatiblePools,cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "since": "4.18.0", "type": "uuid" }, { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the pod ID", + "description": "the availability zone ID", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "list by network id", + "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": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list vms by affinity group", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list by the service offering", @@ -1837,114 +1845,110 @@ "type": "uuid" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", - "length": 255, - "name": "accumulate", - "required": false, - "since": "4.17.0", - "type": "boolean" - }, - { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "haenable", + "name": "showicon", "required": false, - "since": "4.15", + "since": "4.16.0.0", "type": "boolean" } ], "related": "listVirtualMachinesMetrics", "response": [ { - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the total disk iops", - "name": "diskiopstotal", - "type": "long" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, - {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the total memory capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotal", + "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 type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { @@ -1953,33 +1957,39 @@ "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, + {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { @@ -1987,418 +1997,82 @@ "name": "username", "type": "string" }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, { "description": "the name of the service offering of the virtual machine", "name": "serviceofferingname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "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 write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "disk read in MiB", - "name": "diskread", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -2407,18 +2081,23 @@ "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "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": "account owning the security group rule", + "name": "account", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -2427,17 +2106,17 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -2455,24 +2134,14 @@ "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", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -2484,36 +2153,26 @@ "description": "customer associated with the tag", "name": "customer", "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" } ], "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { @@ -2522,101 +2181,29 @@ "type": "integer" }, { - "description": "the project name of the group", - "name": "project", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the project name of the group", + "name": "project", "type": "string" }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, { "description": "the list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "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": "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", @@ -2628,8 +2215,8 @@ "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" }, { @@ -2637,33 +2224,43 @@ "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -2672,8 +2269,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -2682,257 +2279,667 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "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 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 resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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": "the description of the security group", + "name": "description", + "type": "string" } ], "type": "set" }, { - "description": "disk write in MiB", - "name": "diskwrite", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the 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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "network write in MiB", - "name": "networkwrite", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "disk write in MiB", + "name": "diskwrite", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "network read in MiB", + "name": "networkread", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "network read in MiB", - "name": "networkread", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "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", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "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 write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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 ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "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": "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "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 traffic type of the nic", + "name": "traffictype", + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + } + ], + "type": "set" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, - {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "network write in MiB", + "name": "networkwrite", "type": "string" - } - ] - }, - { + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "disk read in MiB", + "name": "diskread", + "type": "string" + } + ] + }, + { "description": "Lists hosts.", "isasync": false, "name": "listHosts", "params": [ + { + "description": "list hosts for which out-of-band management is enabled", + "length": 255, + "name": "outofbandmanagementenabled", + "required": false, + "type": "boolean" + }, { "description": "the Zone ID for the host", "length": 255, @@ -2949,25 +2956,24 @@ "type": "integer" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "the state of the host", "length": 255, - "name": "hypervisor", + "name": "state", "required": false, "type": "string" }, { - "description": "lists hosts existing in particular cluster", + "description": "the name of the host", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Pod ID for the host", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, "type": "uuid" }, @@ -2979,51 +2985,45 @@ "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": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list hosts for which out-of-band management is enabled", + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, - "name": "outofbandmanagementenabled", + "name": "details", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "the host type", + "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": "type", + "name": "outofbandmanagementpowerstate", "required": false, "type": "string" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "the Pod ID for the host", "length": 255, - "name": "resourcestate", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the state of the host", + "description": "", "length": 255, - "name": "state", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the name of the host", + "description": "the host type", "length": 255, - "name": "name", + "name": "type", "required": false, "type": "string" }, @@ -3036,156 +3036,40 @@ "type": "uuid" }, { - "description": "the id of the host", + "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "name": "resourcestate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "the id of the host", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "keyword", + "name": "hypervisor", "required": false, "type": "string" } ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", "response": [ { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, - { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - {}, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "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 host type", + "name": "type", + "type": "type" }, { "description": "Host details in key/value pairs.", "name": "details", "type": "map" }, - { - "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": "GPU cards present in the host", "name": "gpugroup", @@ -3200,18 +3084,18 @@ "name": "vgpu", "response": [ { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { @@ -3220,23 +3104,23 @@ "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" } ], @@ -3246,175 +3130,291 @@ "type": "list" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "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", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, { "description": "comma-separated list of tags for the host", "name": "hosttags", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { "description": "the last time this host was annotated", "name": "lastannotated", "type": "date" }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" + }, { "description": "the host hypervisor", "name": "hypervisor", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "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 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", + "type": "boolean" + }, + { + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, { "description": "Whether the informed tag is a JS interpretable rule or not.", "name": "istagarule", "type": "boolean" }, { - "description": "the host version", - "name": "version", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + {}, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, {}, { - "description": "events available for the host", - "name": "events", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", @@ -3422,13 +3422,13 @@ "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the Pod name of the host", + "name": "podname", "type": "string" } ] @@ -3442,7 +3442,7 @@ "description": "Storage pool id", "length": 255, "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools", + "related": "listVsphereStoragePolicyCompatiblePools,cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" }, @@ -3455,7 +3455,16 @@ } ], "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", @@ -3466,17 +3475,8 @@ "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" - } + {} ] }, { @@ -3484,13 +3484,6 @@ "isasync": false, "name": "listVsphereStoragePolicyCompatiblePools", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -3499,12 +3492,11 @@ "type": "string" }, { - "description": "ID of the zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "ID of the storage policy", @@ -3514,6 +3506,14 @@ "required": false, "type": "uuid" }, + { + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -3525,23 +3525,38 @@ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "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": "Storage provider for this pool", + "name": "provider", "type": "string" }, { @@ -3550,14 +3565,14 @@ "type": "string" }, { - "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 storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { "description": "the host's currently allocated disk size", @@ -3565,49 +3580,29 @@ "type": "long" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - {}, - { - "description": "the storage pool path", - "name": "path", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, + {}, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { @@ -3616,8 +3611,8 @@ "type": "boolean" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { @@ -3626,50 +3621,55 @@ "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, {}, { - "description": "the storage pool type", - "name": "type", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "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": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" } ] }, @@ -3689,26 +3689,26 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { - "description": "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.17.0.0" @@ -3718,6 +3718,13 @@ "isasync": false, "name": "updateStoragePool", "params": [ + { + "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", "length": 255, @@ -3734,12 +3741,11 @@ "type": "boolean" }, { - "description": "the Id of the storage pool", + "description": "bytes CloudStack can provision from this storage pool", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" + "name": "capacitybytes", + "required": false, + "type": "long" }, { "description": "false to disable the pool for allocation of new volumes, true to enable it back.", @@ -3748,6 +3754,14 @@ "required": false, "type": "boolean" }, + { + "description": "the Id of the storage pool", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" + }, { "description": "the details for the storage pool", "length": 255, @@ -3765,20 +3779,6 @@ "since": "4.15", "type": "string" }, - { - "description": "comma-separated list of tags for the storage pool", - "length": 255, - "name": "tags", - "required": false, - "type": "list" - }, - { - "description": "bytes CloudStack can provision from this storage pool", - "length": 255, - "name": "capacitybytes", - "required": false, - "type": "long" - }, { "description": "IOPS CloudStack can provision from this storage pool", "length": 255, @@ -3789,75 +3789,62 @@ ], "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the storage pool path", - "name": "path", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { "description": "the storage pool capabilities", @@ -3865,29 +3852,24 @@ "type": "map" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - }, - { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "IOPS CloudStack can provision from this storage pool", @@ -3895,35 +3877,28 @@ "type": "long" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - {}, - { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { @@ -3932,10 +3907,35 @@ "type": "storagepoolstatus" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" - } + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" + }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + } ], "since": "3.0.0" }, @@ -3964,39 +3964,34 @@ "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, {}, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { @@ -4005,59 +4000,59 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the system VM", + "name": "name", + "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", + "type": "string" }, { "description": "the public MAC address for the system VM", @@ -4065,34 +4060,29 @@ "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" - }, - { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { "description": "the number of active console sessions for the console proxy system vm", @@ -4100,9 +4090,14 @@ "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 link local IP address for the system vm", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { "description": "the second DNS for the system VM", @@ -4110,19 +4105,25 @@ "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { "description": "the first DNS for the system VM", @@ -4130,51 +4131,50 @@ "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" - }, - {} + } ] }, { @@ -4183,23 +4183,16 @@ "name": "listTungstenFabricTag", "params": [ { - "description": "the uuid of Tungsten-Fabric network", - "length": 255, - "name": "networkuuid", - "required": false, - "type": "string" - }, - { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "", "length": 255, - "name": "applicationpolicysetuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "keyword", + "name": "networkuuid", "required": false, "type": "string" }, @@ -4211,23 +4204,31 @@ "type": "string" }, { - "description": "the uuid of Tungsten-Fabric tag", + "description": "the ID of zone", "length": 255, - "name": "taguuid", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "policyuuid", + "name": "applicationpolicysetuuid", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, @@ -4239,47 +4240,47 @@ "type": "string" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "page", + "name": "policyuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "taguuid", "required": false, - "type": "uuid" + "type": "string" } ], "related": "createTungstenFabricTag,applyTungstenFabricTag,removeTungstenFabricTag", "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", + "description": "list Tungsten-Fabric network", + "name": "network", "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, + {}, { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, { "description": "Tungsten-Fabric provider zone id", @@ -4287,27 +4288,26 @@ "type": "long" }, { - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "Tungsten-Fabric tag name", "name": "name", "type": "string" }, - {} + { + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" + } ] }, { @@ -4315,20 +4315,6 @@ "isasync": false, "name": "importLdapUsers", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "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, @@ -4337,11 +4323,12 @@ "type": "string" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "Creates the account under the specified role.", "length": 255, - "name": "accounttype", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "details for account used to store specific parameters", @@ -4353,18 +4340,10 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, - { - "description": "Creates the account under the specified role.", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" - }, { "description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.", "length": 255, @@ -4380,24 +4359,45 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, "name": "timezone", "required": false, "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "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" } ], "related": "searchLdap,listLdapUsers", "response": [ { - "description": "The user's firstname", - "name": "firstname", + "description": "The user's email", + "name": "email", "type": "string" }, { - "description": "The user's email", - "name": "email", + "description": "The user's domain", + "name": "domain", "type": "string" }, { @@ -4406,34 +4406,34 @@ "type": "string" }, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The user's lastname", + "name": "lastname", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The user's principle", + "name": "principal", "type": "string" }, { - "description": "The user's lastname", - "name": "lastname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The user's domain", - "name": "domain", + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", "type": "string" }, + {}, { - "description": "The user's principle", - "name": "principal", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {} @@ -4464,40 +4464,19 @@ ], "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "response": [ - { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", - "type": "string" - }, - {}, { "description": "the total primary storage space (in GiB) available to be used for this domain", "name": "primarystorageavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { @@ -4506,38 +4485,23 @@ "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { @@ -4546,118 +4510,83 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the ID of the domain", + "name": "id", "type": "string" }, - { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" - }, { "description": "the level of the domain", "name": "level", "type": "integer" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the path of the domain", - "name": "path", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "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": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -4666,34 +4595,35 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, + {}, { - "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 vpcs owned by domain", - "name": "vpctotal", - "type": "long" - }, { "description": "the name of the domain", "name": "name", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" }, { "description": "the total memory (in MB) owned by domain", @@ -4701,98 +4631,64 @@ "type": "long" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the state of the domain", + "name": "state", "type": "string" }, - {} - ], - "since": "4.19.0.0" - }, - { - "description": "List dedicated zones.", - "isasync": false, - "name": "listDedicatedZones", - "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the ID of the Zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "list dedicated zones by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", - "required": false, - "type": "uuid" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the name of the account associated with the zone. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the ID of the domain associated with the zone", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - } - ], - "related": "dedicateZone", - "response": [ - {}, - { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", - "type": "string" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, + {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { @@ -4801,32 +4697,32 @@ "type": "integer" }, { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, - {}, { - "description": "the Name of the Zone", - "name": "zonename", - "type": "string" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { - "description": "the ID of the Zone", - "name": "zoneid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" } - ] + ], + "since": "4.19.0.0" }, { "description": "Lists all available networks.", @@ -4834,84 +4730,93 @@ "name": "listNetworks", "params": [ { - "description": "list networks by ID", + "description": "type of the traffic", "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "traffictype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list networks by restartRequired", "length": 255, - "name": "displaynetwork", + "name": "restartrequired", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "list networks by network offering ID", + "description": "the zone ID of the network", "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if network is system, false otherwise", + "description": "the type of the network. Supported values are: isolated, l2, shared and all", "length": 255, - "name": "issystem", + "name": "type", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "list networks by ID", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "type", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "flag to display the resource icon for networks", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "showicon", + "required": false, + "type": "boolean" + }, + { + "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": "list resources by account. Must be used with the domainId parameter.", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "account", + "name": "retrieveonlyresourcecount", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list networks by restartRequired", + "description": "true if need to list only networks which support specifying IP ranges", "length": 255, - "name": "restartrequired", + "name": "specifyipranges", "required": false, "type": "boolean" }, { - "description": "list networks available for VM deployment", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "canusefordeploy", + "name": "displaynetwork", "required": false, + "since": "4.4", "type": "boolean" }, { @@ -4922,117 +4827,115 @@ "type": "string" }, { - "description": "List networks by VPC", + "description": "the ID or VID of the network", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "vlan", "required": false, - "type": "uuid" + "since": "4.17.0", + "type": "string" }, { - "description": "", + "description": "the network belongs to VPC", "length": 255, - "name": "page", + "name": "forvpc", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the zone ID of the network", + "description": "list networks supporting certain services", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "supportedservices", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "list networks by physical network id", + "description": "list networks available for VM deployment", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "canusefordeploy", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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": "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).", + "description": "", "length": 255, - "name": "networkfilter", + "name": "page", "required": false, - "since": "4.17.0", - "type": "string" + "type": "integer" }, { - "description": "list networks by ACL (access control list) type. Supported values are account and domain", + "description": "list networks by network offering ID", "length": 255, - "name": "acltype", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "flag to display the resource icon for networks", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "showicon", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "type of the traffic", + "description": "List networks by VPC", "length": 255, - "name": "traffictype", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "list networks by physical network id", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the network belongs to VPC", + "description": "true if network is system, false otherwise", "length": 255, - "name": "forvpc", + "name": "issystem", "required": false, "type": "boolean" }, { - "description": "the ID or VID of the network", + "description": "list networks by ACL (access control list) type. Supported values are account and domain", "length": 255, - "name": "vlan", + "name": "acltype", "required": false, - "since": "4.17.0", "type": "string" }, { - "description": "true if need to list only networks which support specifying IP ranges", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "specifyipranges", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "List networks by associated networks. Only available if create a Shared network.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.17.0", "type": "uuid" }, { - "description": "list networks supporting certain services", + "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": "supportedservices", + "name": "networkfilter", "required": false, - "type": "list" + "since": "4.17.0", + "type": "string" }, { "description": "List resources by tags (key/value pairs)", @@ -5040,100 +4943,64 @@ "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" } ], "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the name of the network", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, + {}, { - "description": "the network's gateway", - "name": "gateway", - "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": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { @@ -5141,243 +5008,267 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the network's gateway", + "name": "gateway", "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 second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the Network associated with this network", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "the name of the Network associated with this private gateway", "name": "associatednetwork", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the 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": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "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 details of the network", - "name": "details", - "type": "map" + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "related to what other network configuration", - "name": "related", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "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": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the owner of the network", - "name": "account", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" }, { "description": "the total number of network traffic bytes received", @@ -5385,13 +5276,13 @@ "type": "long" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { @@ -5400,23 +5291,38 @@ "type": "boolean" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { @@ -5433,38 +5339,38 @@ "name": "provider", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "state of the network provider", + "name": "state", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "the provider name", "name": "name", "type": "string" }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], @@ -5474,6 +5380,11 @@ "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", @@ -5483,11 +5394,6 @@ "description": "the capability name", "name": "name", "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" } ], "type": "list" @@ -5496,59 +5402,153 @@ "type": "list" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, + {}, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, - {}, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + } + ] + }, + { + "description": "List dedicated zones.", + "isasync": false, + "name": "listDedicatedZones", + "params": [ + { + "description": "the ID of the Zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the name of the account associated with the zone. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the id of the network", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the domain associated with the zone", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list dedicated zones by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "dedicateZone", + "response": [ + { + "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 Network associated with this private gateway", - "name": "associatednetwork", + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", + "type": "string" + }, + {}, + {}, + { + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", + "type": "string" + }, + { + "description": "the ID of the Zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain ID to which the Zone is dedicated", + "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 Zone", + "name": "zonename", "type": "string" } ] @@ -5568,21 +5568,12 @@ ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current available space of the pool", "name": "size", "type": "long" }, - { - "description": "the name of the storage pool", - "name": "name", - "type": "string" - }, + {}, { "description": "default gateway of the pool", "name": "gateway", @@ -5590,14 +5581,9 @@ }, {}, { - "description": "available iops of the pool", - "name": "maxiops", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { "description": "the state of the storage pool", @@ -5605,16 +5591,30 @@ "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "controller of the pool", + "name": "controllerid", "type": "string" }, { - "description": "controller of the pool", - "name": "controllerid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "available iops of the pool", + "name": "maxiops", + "type": "long" + } ] }, { @@ -5632,28 +5632,28 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.17" }, @@ -5663,34 +5663,34 @@ "name": "updatePodManagementNetworkIpRange", "params": [ { - "description": "The new starting IP address.", + "description": "The new ending IP address.", "length": 255, - "name": "newstartip", + "name": "newendip", "required": false, "type": "string" }, { - "description": "The new ending IP address.", + "description": "The new starting IP address.", "length": 255, - "name": "newendip", + "name": "newstartip", "required": false, "type": "string" }, { - "description": "The current starting IP address.", + "description": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "currentstartip", + "name": "podid", "related": "listPods,updatePod,createManagementNetworkIpRange", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "UUID of POD, where the IP range belongs to.", + "description": "The current starting IP address.", "length": 255, - "name": "podid", + "name": "currentstartip", "related": "listPods,updatePod,createManagementNetworkIpRange", "required": true, - "type": "uuid" + "type": "string" }, { "description": "The current ending IP address.", @@ -5702,27 +5702,27 @@ } ], "response": [ + {}, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "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.16.0.0" @@ -5732,25 +5732,17 @@ "isasync": false, "name": "listTungstenFabricLBHealthMonitor", "params": [ - { - "description": "the ID of lb rule", - "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -5760,33 +5752,46 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "the ID of lb rule", + "length": 255, + "name": "lbruleid", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": true, + "type": "uuid" } ], "related": "updateTungstenFabricLBHealthMonitor", "response": [ { - "description": "the health monitor ID", - "name": "id", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "the health monitor timeout", + "name": "timeout", + "type": "int" }, { - "description": "the health monitor retry", - "name": "retry", + "description": "the health monitor interval", + "name": "interval", "type": "int" }, { - "description": "the health monitor http method", - "name": "httpmethod", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the health monitor url path", + "name": "urlpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { @@ -5794,48 +5799,43 @@ "name": "uuid", "type": "string" }, + {}, { - "description": "the health monitor url path", - "name": "urlpath", - "type": "string" + "description": "the health monitor retry", + "name": "retry", + "type": "int" }, { - "description": "the health monitor expected code", - "name": "expectedcode", + "description": "the health monitor type", + "name": "type", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the health monitor timeout", - "name": "timeout", - "type": "int" + "description": "the health monitor ID", + "name": "id", + "type": "long" }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, - {}, - { - "description": "the health monitor interval", - "name": "interval", - "type": "int" - }, { "description": "the LB rule ID", "name": "lbruleid", "type": "string" }, + {}, { - "description": "the health monitor type", - "name": "type", + "description": "the health monitor http method", + "name": "httpmethod", "type": "string" }, - {} + { + "description": "the health monitor expected code", + "name": "expectedcode", + "type": "string" + } ] }, { @@ -5843,6 +5843,14 @@ "isasync": true, "name": "updateFirewallRule", "params": [ + { + "description": "the ID of the firewall rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "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, @@ -5851,14 +5859,6 @@ "since": "4.4", "type": "string" }, - { - "description": "the ID of the firewall rule", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" - }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -5871,57 +5871,124 @@ "related": "createEgressFirewallRule,createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", "response": [ { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "error code for this icmp message", "name": "icmpcode", "type": "integer" }, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" + }, + {}, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -5930,84 +5997,17 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" - }, { "description": "the public ip address for the firewall rule", "name": "ipaddress", "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "description": "the 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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" } ], "since": "4.4" @@ -6019,23 +6019,23 @@ "params": [], "related": "", "response": [ - { - "description": "is quota service enabled", - "name": "isenabled", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + { + "description": "is quota service enabled", + "name": "isenabled", + "type": "boolean" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.7.0" }, @@ -6054,43 +6054,112 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Lists all quota email templates", + "isasync": false, + "name": "quotaEmailTemplateList", + "params": [ + { + "description": "List by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", + "length": 255, + "name": "templatetype", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "The quota email template locale", + "name": "locale", "type": "string" }, {}, + { + "description": "The quota email template subject", + "name": "templatesubject", + "type": "string" + }, + { + "description": "Last date/time when template was updated", + "name": "last_updated", + "type": "date" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + "description": "The quota email template content", + "name": "templatebody", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Template type", + "name": "templatetype", + "type": "string" + }, + {} ], - "since": "4.19.0" + "since": "4.7.0" }, { "description": "Deletes account from the project", "isasync": true, "name": "deleteAccountFromProject", "params": [ - { - "description": "name of the account to be removed from the project", - "length": 255, - "name": "account", - "required": true, - "type": "string" - }, { "description": "ID of the project to remove the account from", "length": 255, @@ -6098,31 +6167,38 @@ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, "type": "uuid" + }, + { + "description": "name of the account to be removed from the project", + "length": 255, + "name": "account", + "required": true, + "type": "string" } ], "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "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": "3.0.0" }, @@ -6142,11 +6218,6 @@ ], "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", @@ -6158,7 +6229,12 @@ "name": "name", "type": "string" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -6173,6 +6249,13 @@ "required": false, "type": "map" }, + { + "description": "Unique display name for Guest OS", + "length": 255, + "name": "osdisplayname", + "required": true, + "type": "string" + }, { "description": "UUID of the Guest OS", "length": 255, @@ -6187,36 +6270,34 @@ "name": "forDisplay", "required": false, "type": "boolean" - }, - { - "description": "Unique display name for Guest OS", - "length": 255, - "name": "osdisplayname", - "required": true, - "type": "string" } ], "related": "listOsTypes,addGuestOs", "response": [ { - "description": "the name of the OS category", - "name": "oscategoryname", + "description": "the name/description of the OS type", + "name": "description", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the name of the OS type", - "name": "name", + "description": "the ID of the OS type", + "name": "id", "type": "string" }, { - "description": "is the guest OS visible for the users", - "name": "fordisplay", + "description": "the name of the OS category", + "name": "oscategoryname", + "type": "string" + }, + {}, + { + "description": "is the guest OS user defined", + "name": "isuserdefined", "type": "boolean" }, { @@ -6224,26 +6305,21 @@ "name": "jobid", "type": "string" }, - { - "description": "the ID of the OS type", - "name": "id", - "type": "string" - }, { "description": "the ID of the OS category", "name": "oscategoryid", "type": "string" }, - {}, { - "description": "the name/description of the OS type", - "name": "description", + "description": "the name of the OS type", + "name": "name", "type": "string" }, + {}, { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.4.0" @@ -6254,18 +6330,25 @@ "name": "listGuestVlans", "params": [ { - "description": "limits search results to allocated guest vlan. false by default.", + "description": "", "length": 255, - "name": "allocatedonly", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list guest vlan by vnet", + "description": "", "length": 255, - "name": "vnet", + "name": "page", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "limits search results to allocated guest vlan. false by default.", + "length": 255, + "name": "allocatedonly", + "required": false, + "type": "boolean" }, { "description": "list guest vlan by id", @@ -6282,13 +6365,6 @@ "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "list guest vlan by physical network", "length": 255, @@ -6298,45 +6374,50 @@ "type": "uuid" }, { - "description": "", + "description": "list guest vlan by vnet", "length": 255, - "name": "pagesize", + "name": "vnet", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the zone ID of the guest VLAN range", - "name": "zoneid", + "description": "the guest VLAN", + "name": "vlan", "type": "string" }, + { + "description": "true if the guest VLAN is dedicated to the account", + "name": "isdedicated", + "type": "boolean" + }, { "description": "the domain ID of the guest VLAN range", "name": "domainid", "type": "string" }, { - "description": "the physical network name of the guest VLAN range", - "name": "physicalnetworkname", + "description": "the project name of the guest VLAN range", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "date the guest VLAN was taken", + "name": "taken", + "type": "date" }, { - "description": "the guest VLAN", - "name": "vlan", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, { @@ -6345,23 +6426,18 @@ "type": "string" }, { - "description": "the zone name of the guest VLAN range", - "name": "zonename", - "type": "string" - }, - { - "description": "the physical network ID of the guest VLAN range", - "name": "physicalnetworkid", + "description": "the allocation state of the guest VLAN", + "name": "allocationstate", "type": "string" }, { - "description": "the account of the guest VLAN range", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the zone ID of the guest VLAN range", + "name": "zoneid", "type": "string" }, { @@ -6369,15 +6445,24 @@ "name": "id", "type": "long" }, + { + "description": "the physical network ID of the guest VLAN range", + "name": "physicalnetworkid", + "type": "string" + }, { "description": "the domain name of the guest VLAN range", "name": "domain", "type": "string" }, - {}, { - "description": "the project name of the guest VLAN range", - "name": "project", + "description": "the physical network name of the guest VLAN range", + "name": "physicalnetworkname", + "type": "string" + }, + { + "description": "the zone name of the guest VLAN range", + "name": "zonename", "type": "string" }, { @@ -6386,20 +6471,11 @@ "type": "list" }, { - "description": "the allocation state of the guest VLAN", - "name": "allocationstate", + "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": "date the guest VLAN was taken", - "name": "taken", - "type": "date" - }, + {}, {} ], "since": "4.17.0" @@ -6410,11 +6486,19 @@ "name": "updateResourceLimit", "params": [ { - "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "Update resource limits for project", "length": 255, - "name": "resourcetype", - "required": true, - "type": "integer" + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": " Maximum resource limit.", + "length": 255, + "name": "max", + "required": false, + "type": "long" }, { "description": "Update resource for a specified account. Must be used with the domainId parameter.", @@ -6432,75 +6516,67 @@ "type": "uuid" }, { - "description": " Maximum resource limit.", - "length": 255, - "name": "max", - "required": false, - "type": "long" - }, - { - "description": "Update resource limits for project", + "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "name": "resourcetype", + "required": true, + "type": "integer" } ], "related": "listResourceLimits", "response": [ - { - "description": "the project name of the resource limit", - "name": "project", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "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 maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" + "description": "the domain ID of the resource limit", + "name": "domainid", + "type": "string" }, { - "description": "the account of the resource limit", - "name": "account", + "description": "the project name of the resource limit", + "name": "project", "type": "string" }, { - "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", + "description": "the domain name of the resource limit", + "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 domain ID of the resource limit", - "name": "domainid", + "description": "the account of the resource limit", + "name": "account", "type": "string" }, { - "description": "the domain name of the resource limit", - "name": "domain", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" - } + }, + { + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" + }, + {} ] }, { @@ -6518,12 +6594,18 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -6533,13 +6615,7 @@ "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" - }, - {} + } ] }, { @@ -6548,11 +6624,18 @@ "name": "listHostsMetrics", "params": [ { - "description": "if true, list only hosts dedicated to HA", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "hahost", + "name": "hypervisor", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "length": 255, + "name": "resourcestate", + "required": false, + "type": "string" }, { "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", @@ -6563,40 +6646,40 @@ "type": "uuid" }, { - "description": "", + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, - "name": "pagesize", + "name": "details", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the name of the host", + "description": "the host type", "length": 255, - "name": "name", + "name": "type", "required": false, "type": "string" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "the Zone ID for the host", "length": 255, - "name": "hypervisor", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "page", + "name": "hahost", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "lists hosts existing in particular cluster", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the state of the host", @@ -6613,101 +6696,94 @@ "type": "boolean" }, { - "description": "the Pod ID for the host", + "description": "the id of the host", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, "type": "uuid" }, { - "description": "the host type", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, - { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "description": "", "length": 255, - "name": "details", + "name": "page", "required": false, - "type": "list" + "type": "integer" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "the Pod ID for the host", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the name of the host", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "the id of the host", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, "type": "uuid" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "List by keyword", "length": 255, - "name": "resourcestate", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the Zone ID for the host", + "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "outofbandmanagementpowerstate", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "instances on the host", + "name": "instances", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "system vm instances on the host", + "name": "systeminstances", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { "description": "the amount of the host's memory currently allocated", @@ -6715,130 +6791,134 @@ "type": "long" }, { - "description": "instances on the host", - "name": "instances", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total memory used in GiB", + "name": "memoryusedgb", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the average cpu load the last minute", - "name": "cpuloadaverage", - "type": "double" + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "out-of-band management power state", - "name": "powerstate", - "type": "powerstate" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the average cpu load the last minute", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the total memory allocated in GiB", - "name": "memoryallocatedgb", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the total memory capacity in GiB", + "name": "memorytotalgb", "type": "string" }, { - "description": "network read in GiB", - "name": "networkread", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the total cpu used in Ghz", + "name": "cpuusedghz", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotalgb", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocatedghz", "type": "string" }, - {}, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { "description": "the OS category ID of the host", @@ -6846,222 +6926,180 @@ "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocatedghz", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the total cpu capacity in Ghz", + "name": "cputotalghz", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "network write in GiB", - "name": "networkwrite", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "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": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, + {}, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "out-of-band management power state", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the total memory used in GiB", - "name": "memoryusedgb", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotalghz", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", "type": "boolean" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "network read in GiB", + "name": "networkread", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", "type": "boolean" }, { - "description": "the ID of the host", - "name": "id", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { @@ -7070,76 +7108,114 @@ "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "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": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, - {}, { - "description": "the total cpu used in Ghz", - "name": "cpuusedghz", + "description": "the total memory allocated in GiB", + "name": "memoryallocatedgb", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "network write in GiB", + "name": "networkwrite", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "system vm instances on the host", - "name": "systeminstances", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "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": "the CPU number of the host", "name": "cpunumber", "type": "integer" }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, { "description": "true if the host is disconnected. False otherwise.", "name": "disconnected", @@ -7164,13 +7240,6 @@ ], "related": "", "response": [ - { - "description": "crt", - "name": "crt", - "type": "string" - }, - {}, - {}, { "description": "chain", "name": "chain", @@ -7181,16 +7250,23 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "key", + "name": "key", + "type": "string" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "key", - "name": "key", + "description": "crt", + "name": "crt", "type": "string" - } + }, + {} ] }, { @@ -7209,9 +7285,9 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -7219,18 +7295,69 @@ "type": "string" }, {}, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Cancels a triggered shutdown", + "isasync": false, + "name": "cancelShutdown", + "params": [ + { + "description": "the uuid of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": true, + "type": "uuid" + } + ], + "related": "prepareForShutdown,readyForShutdown,triggerShutdown", + "response": [ + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + }, + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" + }, + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} - ] + ], + "since": "4.19.0" }, { "description": "Lists affinity groups", @@ -7238,117 +7365,106 @@ "name": "listAffinityGroups", "params": [ { - "description": "lists affinity groups by type", + "description": "", "length": 255, - "name": "type", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "", + "description": "lists affinity groups by virtual machine ID", "length": 255, - "name": "pagesize", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "lists affinity groups by name", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "lists affinity groups by type", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" }, { - "description": "list the affinity group by the ID provided", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", + "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": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list the affinity group by the ID provided", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "required": false, "type": "uuid" }, { - "description": "lists affinity groups by virtual machine ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "lists affinity groups by name", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" } ], "related": "createAffinityGroup", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the type of the affinity group", "name": "type", "type": "string" }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, { "description": "the account owning the affinity group", "name": "account", @@ -7361,13 +7477,18 @@ }, {}, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { @@ -7376,9 +7497,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the affinity group", + "name": "id", + "type": "string" }, { "description": "virtual machine IDs associated with this affinity group", @@ -7386,81 +7507,50 @@ "type": "list" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + {}, + { + "description": "the description of the affinity group", + "name": "description", "type": "string" } ] }, { - "description": "Cancels a triggered shutdown", + "description": "Register a public key in a keypair under a certain name", "isasync": false, - "name": "cancelShutdown", + "name": "registerSSHKeyPair", "params": [ { - "description": "the uuid of the management server", + "description": "Name of the keypair", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "name", "required": true, - "type": "uuid" - } - ], - "related": "prepareForShutdown,readyForShutdown,triggerShutdown", - "response": [ - { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "an optional account for the ssh key. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "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" - } - ], - "since": "4.19.0" - }, - { - "description": "Register a public key in a keypair under a certain name", - "isasync": false, - "name": "registerSSHKeyPair", - "params": [ - { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "description": "an optional project for the ssh key", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "an optional project for the ssh key", + "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, @@ -7470,56 +7560,26 @@ "name": "publickey", "required": true, "type": "string" - }, - { - "description": "an optional account for the ssh key. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], "related": "listSSHKeyPairs", "response": [ { - "description": "Name of the keypair", - "name": "name", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the domain id of the keypair owner", "name": "domainid", "type": "string" }, { - "description": "the domain name of the keypair owner", - "name": "domain", - "type": "string" - }, - { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "ID of the ssh keypair", "name": "id", @@ -7530,20 +7590,36 @@ "name": "account", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the keypair owner", + "name": "projectid", + "type": "string" + }, + { + "description": "Name of the keypair", + "name": "name", + "type": "string" + }, { "description": "Fingerprint of the public key", "name": "fingerprint", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -7562,17 +7638,6 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -7583,6 +7648,17 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -7592,50 +7668,50 @@ "name": "startRollingMaintenance", "params": [ { - "description": "optional operation timeout (in seconds) that overrides the global timeout setting", + "description": "the IDs of the clusters to start maintenance on", "length": 255, - "name": "timeout", + "name": "clusterids", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the IDs of the pods to start maintenance on", + "description": "the IDs of the hosts to start maintenance on", "length": 255, - "name": "podids", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "hostids", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, "type": "list" }, { - "description": "the IDs of the hosts to start maintenance on", + "description": "optional operation timeout (in seconds) that overrides the global timeout setting", "length": 255, - "name": "hostids", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "name": "timeout", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the IDs of the clusters to start maintenance on", + "description": "the IDs of the zones to start maintenance on", "length": 255, - "name": "clusterids", - "related": "addCluster,listClusters,updateCluster", + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "list" }, { - "description": "the command to execute while hosts are on maintenance", + "description": "the IDs of the pods to start maintenance on", "length": 255, - "name": "payload", + "name": "podids", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "list" }, { - "description": "the IDs of the zones to start maintenance on", + "description": "the command to execute while hosts are on maintenance", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "payload", "required": false, - "type": "list" + "type": "string" }, { "description": "if rolling mechanism should continue in case of an error", @@ -7652,8 +7728,8 @@ "name": "hostsskipped", "response": [ { - "description": "the name of the skipped host", - "name": "hostname", + "description": "the ID of the skipped host", + "name": "hostid", "type": "string" }, { @@ -7662,8 +7738,8 @@ "type": "string" }, { - "description": "the ID of the skipped host", - "name": "hostid", + "description": "the name of the skipped host", + "name": "hostname", "type": "string" } ], @@ -7674,6 +7750,22 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "in case of failure, details are displayed", + "name": "details", + "type": "string" + }, + {}, + { + "description": "indicates if the rolling maintenance operation was successful", + "name": "success", + "type": "boolean" + }, { "description": "the hosts updated", "name": "hostsupdated", @@ -7683,11 +7775,6 @@ "name": "hostname", "type": "string" }, - { - "description": "output of the maintenance script on the host", - "name": "output", - "type": "string" - }, { "description": "the ID of the updated host", "name": "hostid", @@ -7702,27 +7789,16 @@ "description": "start date of the update on the host", "name": "startdate", "type": "string" + }, + { + "description": "output of the maintenance script on the host", + "name": "output", + "type": "string" } ], "type": "list" }, - { - "description": "in case of failure, details are displayed", - "name": "details", - "type": "string" - }, - {}, - {}, - { - "description": "indicates if the rolling maintenance operation was successful", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -7730,6 +7806,13 @@ "isasync": false, "name": "listTungstenFabricApplicationPolicySet", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -7745,70 +7828,63 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the ID of zone", "length": 255, - "name": "applicationpolicysetuuid", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "keyword", + "name": "applicationpolicysetuuid", "required": false, "type": "string" - }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" } ], "related": "createTungstenFabricApplicationPolicySet", "response": [ {}, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", "type": "string" }, - {}, { - "description": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", + "description": "list Tungsten-Fabric tag", + "name": "tag", "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" }, { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "Tungsten-Fabric application policy uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" } ] @@ -7834,6 +7910,14 @@ "since": "4.4", "type": "boolean" }, + { + "description": "the ID of the network ACL", + "length": 255, + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", + "required": true, + "type": "uuid" + }, { "description": "Name of the network ACL list", "length": 255, @@ -7847,37 +7931,29 @@ "name": "description", "required": false, "type": "string" - }, - { - "description": "the ID of the network ACL", - "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "required": true, - "type": "uuid" } ], "response": [ - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -7888,14 +7964,6 @@ "isasync": false, "name": "reserveIpAddress", "params": [ - { - "description": "the ID of the public IP address to reserve", - "length": 255, - "name": "id", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - }, { "description": "the ID of the project to reserve with this IP address", "length": 255, @@ -7905,11 +7973,18 @@ "type": "uuid" }, { - "description": "the ID of the domain to reserve with this IP address", + "description": "the account to reserve with this IP address", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "account", "required": false, + "type": "string" + }, + { + "description": "the ID of the public IP address to reserve", + "length": 255, + "name": "id", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, "type": "uuid" }, { @@ -7920,38 +7995,113 @@ "type": "boolean" }, { - "description": "the account to reserve with this IP address", + "description": "the ID of the domain to reserve with this IP address", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" } ], "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", + "type": "string" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, + { + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", + "type": "string" + }, { "description": "the list of resource tags associated with ip address", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -7960,8 +8110,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -7970,81 +8120,103 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, + {}, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, { "description": "the ID of the Network where ip belongs to", "name": "networkid", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "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" }, { @@ -8053,265 +8225,352 @@ "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "the project name of the address", - "name": "project", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" - }, + } + ], + "since": "4.17" + }, + { + "description": "Restore a VM to original template/ISO or new template/ISO", + "isasync": true, + "name": "restoreVirtualMachine", + "params": [ { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "Virtual Machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "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", + "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" + } + ], + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "response": [ + {}, { - "description": "public IP address", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, - {}, { - "description": "public IP address id", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "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 this ip is for static nat, false otherwise", - "name": "isstaticnat", + "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 Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" - } - ], - "since": "4.17" - }, - { - "description": "Restore a VM to original template/ISO or new template/ISO", - "isasync": true, - "name": "restoreVirtualMachine", - "params": [ - { - "description": "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO", - "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": "Virtual Machine ID", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + "description": "the 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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "an alternate display text of the 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 list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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 gateway of the nic", "name": "gateway", "type": "string" }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, { "description": "the broadcast uri of the nic", "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -8320,18 +8579,18 @@ "type": "boolean" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -8340,130 +8599,185 @@ "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 name of the corresponding network", - "name": "networkname", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the 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 VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the 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 IPv6 address of network", + "name": "ip6address", "type": "string" }, { "description": "the ID of the nic", "name": "id", "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" } ], "type": "set" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, { "description": "the memory allocated for the virtual machine", "name": "memory", "type": "integer" }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the 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": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, { "description": "Guest vm Boot Type", "name": "boottype", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, - {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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 availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -8471,19 +8785,24 @@ "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", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -8492,50 +8811,35 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the 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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -8543,28 +8847,33 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "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": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the 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", "type": "string" }, { @@ -8573,24 +8882,19 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { "description": "id of the resource", "name": "resourceid", "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" } ], "type": "set" @@ -8600,62 +8904,25 @@ "name": "icmpcode", "type": "integer" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "security group name", "name": "securitygroupname", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ + }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the starting IP of the security group rule", @@ -8663,17 +8930,39 @@ "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 project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -8682,8 +8971,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -8692,13 +8981,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -8707,18 +8991,18 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], @@ -8728,28 +9012,58 @@ "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the 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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -8757,208 +9071,79 @@ "name": "id", "type": "string" }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, { "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, { - "description": "the project id of the vm", - "name": "projectid", + "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 user's name who deployed the virtual machine", - "name": "username", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, + {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the 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 project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - } - ], - "type": "set" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { "description": "the id of userdata used for the VM", @@ -8966,29 +9151,19 @@ "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "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": "device ID of the root volume", "name": "rootdeviceid", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { "description": "the password (if exists) of the virtual machine", @@ -8996,83 +9171,13 @@ "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { @@ -9081,43 +9186,38 @@ "type": "map" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -9126,105 +9226,81 @@ "type": "date" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "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 ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, { "description": "the type of the template for the virtual machine", "name": "templatetype", "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - {}, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" } ], "since": "3.0.0" @@ -9234,13 +9310,6 @@ "isasync": false, "name": "deleteEvents", "params": [ - { - "description": "delete by event type", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, { "description": "the IDs of the events", "length": 255, @@ -9262,29 +9331,36 @@ "name": "enddate", "required": false, "type": "date" + }, + { + "description": "delete by event type", + "length": 255, + "name": "type", + "required": false, + "type": "string" } ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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": "the 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" }, {} ] @@ -9304,11 +9380,18 @@ } ], "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -9318,13 +9401,6 @@ "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" } ] }, @@ -9333,13 +9409,6 @@ "isasync": false, "name": "listUcsBlades", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -9354,6 +9423,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "ucs manager id", "length": 255, @@ -9365,28 +9441,17 @@ ], "related": "associateUcsProfileToBlade", "response": [ - { - "description": "cloudstack host id this blade associates to", - "name": "hostid", - "type": "string" - }, { "description": "ucs manager id", "name": "ucsmanagerid", "type": "string" }, - { - "description": "ucs blade dn", - "name": "bladedn", - "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", @@ -9397,10 +9462,21 @@ "name": "id", "type": "string" }, + {}, + { + "description": "ucs blade dn", + "name": "bladedn", + "type": "string" + }, { "description": "associated ucs profile dn", "name": "profiledn", "type": "string" + }, + { + "description": "cloudstack host id this blade associates to", + "name": "hostid", + "type": "string" } ] }, @@ -9418,28 +9494,28 @@ } ], "response": [ - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -9457,21 +9533,21 @@ ], "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", + "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": "Volume iSCSI Name", + "name": "volumeiScsiName", "type": "string" } ] @@ -9481,14 +9557,6 @@ "isasync": true, "name": "deleteIso", "params": [ - { - "description": "the ID of the ISO file", - "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - }, { "description": "the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones", "length": 255, @@ -9496,30 +9564,38 @@ "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -9529,19 +9605,19 @@ "name": "updateHost", "params": [ { - "description": "list of tags to be added to the host", + "description": "the id of Os category to update the host with", "length": 255, - "name": "hosttags", + "name": "oscategoryid", + "related": "listOsCategories", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the ID of the host to update", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", - "required": true, - "type": "uuid" + "name": "istagarule", + "required": false, + "type": "boolean" }, { "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable", @@ -9551,21 +9627,13 @@ "type": "string" }, { - "description": "the id of Os category to update the host with", + "description": "the ID of the host to update", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": false, + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", + "required": true, "type": "uuid" }, - { - "description": "Change the name of host", - "length": 255, - "name": "name", - "required": false, - "since": "4.15", - "type": "string" - }, { "description": "the new uri for the secondary storage: nfs://host/path", "length": 255, @@ -9574,11 +9642,12 @@ "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "description": "Change the name of host", "length": 255, - "name": "istagarule", + "name": "name", "required": false, - "type": "boolean" + "since": "4.15", + "type": "string" }, { "description": "Add an annotation to this host", @@ -9587,106 +9656,145 @@ "required": false, "since": "4.11", "type": "string" + }, + { + "description": "list of tags to be added to the host", + "length": 255, + "name": "hosttags", + "required": false, + "type": "list" } ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "response": [ { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the ID of the host", + "name": "id", "type": "string" }, - {}, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, { "description": "the last time this host was annotated", "name": "lastannotated", "type": "date" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum 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": "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 displays per user", + "name": "maxheads", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, - {}, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { "description": "the amount of the host's CPU currently used", @@ -9694,23 +9802,23 @@ "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "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": "the host type", + "name": "type", + "type": "type" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "events available for the host", + "name": "events", "type": "string" }, { @@ -9719,49 +9827,49 @@ "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { "description": "the date and time the host was created", @@ -9769,79 +9877,90 @@ "type": "date" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, + {}, { - "description": "the host version", - "name": "version", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "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 cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { "description": "the outgoing network traffic on the host", @@ -9849,118 +9968,75 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "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": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, + {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -9969,20 +10045,6 @@ "isasync": true, "name": "createEgressFirewallRule", "params": [ - { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "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": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -9999,16 +10061,9 @@ "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", + "description": "the starting port of firewall rule", "length": 255, - "name": "icmptype", + "name": "startport", "required": false, "type": "integer" }, @@ -10021,74 +10076,58 @@ "type": "uuid" }, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "description": "type of firewallrule: system/user", "length": 255, - "name": "protocol", - "required": true, + "name": "type", + "required": false, "type": "string" }, { - "description": "type of firewallrule: system/user", + "description": "the ending port of firewall rule", "length": 255, - "name": "type", + "name": "endport", "required": false, - "type": "string" + "type": "integer" }, { - "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" - } - ], - "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", - "response": [ + }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "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 of the firewall rule", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "length": 255, "name": "protocol", + "required": true, "type": "string" }, - {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "length": 255, "name": "cidrlist", - "type": "string" - }, + "required": false, + "type": "list" + } + ], + "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", + "response": [ { "description": "the starting port of firewall rule's port range", "name": "startport", "type": "integer" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" - }, - {}, - { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -10096,18 +10135,18 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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" }, { @@ -10116,47 +10155,42 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag 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" } ], "type": "list" }, { - "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 ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, { "description": "is rule for display to the regular user", @@ -10164,13 +10198,23 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, { @@ -10179,10 +10223,42 @@ "type": "integer" }, { - "description": "the state of the rule", - "name": "state", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" - } + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + {}, + { + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, + {} ] }, { @@ -10191,20 +10267,19 @@ "name": "listVPCOfferings", "params": [ { - "description": "id of zone VPC offering is associated with", + "description": "list VPC offerings by display text", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "displaytext", "required": false, - "since": "4.13", - "type": "uuid" + "type": "string" }, { - "description": "list VPC offerings by name", + "description": "list VPC offerings by id", "length": 255, - "name": "name", + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -10223,16 +10298,16 @@ "type": "uuid" }, { - "description": "", + "description": "list VPC offerings by state", "length": 255, - "name": "pagesize", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list VPC offerings by display text", + "description": "List by keyword", "length": 255, - "name": "displaytext", + "name": "keyword", "required": false, "type": "string" }, @@ -10251,50 +10326,63 @@ "type": "list" }, { - "description": "list VPC offerings by id", + "description": "id of zone VPC offering is associated with", "length": 255, - "name": "id", - "related": "updateVPCOffering,listVPCOfferings", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, + "since": "4.13", "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list VPC offerings by state", + "description": "list VPC offerings by name", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" } ], "related": "updateVPCOffering", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the vpc offering", + "name": "id", + "type": "string" + }, { "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", "name": "distributedvpcrouter", "type": "boolean" }, { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, + {}, { "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "zoneid", "type": "string" }, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the list of supported services", "name": "service", @@ -10305,22 +10393,34 @@ "type": "string" }, { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "the provider name", - "name": "name", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -10329,41 +10429,29 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { "description": "services for this provider", "name": "servicelist", "type": "list" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" } ], "type": "list" @@ -10372,19 +10460,13 @@ "type": "list" }, { - "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": " indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" }, - {}, { - "description": "the id of the vpc offering", - "name": "id", + "description": "the name of the vpc offering", + "name": "name", "type": "string" }, { @@ -10397,25 +10479,19 @@ "name": "state", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, { "description": "the date this vpc offering was created", "name": "created", "type": "date" }, - {}, { - "description": "the name of the vpc offering", - "name": "name", + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" }, { @@ -10424,9 +10500,9 @@ "type": "string" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "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" } ] }, @@ -10445,17 +10521,17 @@ ], "related": "", "response": [ + { + "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", + "name": "solidFireVolumeSize", + "type": "long" + }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", - "name": "solidFireVolumeSize", - "type": "long" - }, {}, { "description": "the current status of the latest async job acting on this object", @@ -10469,14 +10545,6 @@ "isasync": true, "name": "uploadVolume", "params": [ - { - "description": "the ID of the zone the volume is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, { "description": "Upload volume for the project", "length": 255, @@ -10486,16 +10554,17 @@ "type": "uuid" }, { - "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", + "description": "the ID of the zone the volume is to be hosted on", "length": 255, - "name": "format", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "Image store uuid", "length": 255, - "name": "account", + "name": "imagestoreuuid", "required": false, "type": "string" }, @@ -10514,13 +10583,6 @@ "required": false, "type": "uuid" }, - { - "description": "the name of the volume", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the URL of where the volume is hosted. Possible URL include http:// and https://", "length": 2048, @@ -10537,205 +10599,123 @@ "type": "uuid" }, { - "description": "Image store uuid", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "imagestoreuuid", + "name": "account", "required": false, "type": "string" - } - ], - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "response": [ - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", + "required": true, "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the volume", + "length": 255, + "name": "name", + "required": true, "type": "string" - }, + } + ], + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "response": [ { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "type of the virtual machine", + "name": "vmtype", + "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": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, - {}, { - "description": "ID of the disk volume", - "name": "id", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "type of the disk volume (ROOT or DATADISK)", "name": "type", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the name of the template for the virtual machine", + "name": "templatename", "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": "pod id of the volume", - "name": "podid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "name of the disk volume", + "name": "name", "type": "string" }, {}, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "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": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { @@ -10748,81 +10728,81 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the 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": "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" } ], "type": "set" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -10831,43 +10811,119 @@ "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + {}, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { @@ -10876,69 +10932,89 @@ "type": "boolean" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" } ] }, @@ -10948,27 +11024,18 @@ "name": "listSecurityGroups", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "list the security group by the id provided", + "description": "lists security groups by name", "length": 255, - "name": "id", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "securitygroupname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -10978,10 +11045,10 @@ "type": "boolean" }, { - "description": "lists security groups by virtual machine id", + "description": "list the security group by the id provided", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, "type": "uuid" }, @@ -10993,27 +11060,34 @@ "type": "string" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "lists security groups by name", + "description": "List by keyword", "length": 255, - "name": "securitygroupname", + "name": "keyword", "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "List resources by tags (key/value pairs)", "length": 255, @@ -11022,125 +11096,153 @@ "type": "map" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "lists security groups by virtual machine id", "length": 255, - "name": "page", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createSecurityGroup,updateSecurityGroup", "response": [ { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - {}, - {}, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { "description": "the domain name of the security group", "name": "domain", "type": "string" }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, { "description": "the description of the security group", "name": "description", "type": "string" }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, { "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -11149,135 +11251,113 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "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 starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" } ], "type": "set" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the name of the security group", + "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 egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "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 account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -11285,28 +11365,28 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -11315,23 +11395,23 @@ "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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], @@ -11341,39 +11421,35 @@ "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the 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 virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -11383,47 +11459,47 @@ "name": "configureOutOfBandManagement", "params": [ { - "description": "the host management interface port", + "description": "the host management interface IP address", "length": 255, - "name": "port", + "name": "address", "required": true, "type": "string" }, { - "description": "the host management interface driver, for example: ipmitool", + "description": "the host management interface password", "length": 255, - "name": "driver", + "name": "password", "required": true, "type": "string" }, { - "description": "the host management interface password", + "description": "the ID of the host", "length": 255, - "name": "password", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the host management interface IP address", + "description": "the host management interface driver, for example: ipmitool", "length": 255, - "name": "address", + "name": "driver", "required": true, "type": "string" }, { - "description": "the host management interface user", + "description": "the host management interface port", "length": 255, - "name": "username", + "name": "port", "required": true, "type": "string" }, { - "description": "the ID of the host", + "description": "the host management interface user", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "username", "required": true, - "type": "uuid" + "type": "string" } ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,disableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", @@ -11433,30 +11509,24 @@ "name": "enabled", "type": "boolean" }, - {}, - { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" + }, + { + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { @@ -11464,36 +11534,42 @@ "name": "password", "type": "string" }, - {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the operation result description", + "name": "description", + "type": "string" + }, + { + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" }, { "description": "the out-of-band management interface port", "name": "port", "type": "string" }, + {}, + {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the operation result description", - "name": "description", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" } ], "since": "4.9.0" @@ -11504,19 +11580,18 @@ "name": "listOauthProvider", "params": [ { - "description": "Name of the provider", + "description": "", "length": 255, - "name": "provider", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the OAuth provider", + "description": "", "length": 255, - "name": "id", - "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -11526,74 +11601,75 @@ "type": "string" }, { - "description": "", + "description": "Name of the provider", "length": 255, - "name": "page", + "name": "provider", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the ID of the OAuth provider", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", "response": [ {}, { - "description": "Name of the provider", - "name": "name", + "description": "ID of the provider", + "name": "id", "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" }, { - "description": "Name of the provider", - "name": "provider", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, { - "description": "Description of the provider registered", - "name": "description", + "description": "Name of the provider", + "name": "name", "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, + {}, { "description": "Whether the OAuth provider is enabled or not", "name": "enabled", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "ID of the provider", - "name": "id", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, - {} + { + "description": "Name of the provider", + "name": "provider", + "type": "string" + } ], "since": "4.19.0" }, @@ -11602,13 +11678,6 @@ "isasync": false, "name": "listStorageTags", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -11622,27 +11691,24 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ + {}, + {}, { "description": "the pool ID of the storage tag", "name": "poolid", "type": "long" }, - { - "description": "the name of the storage tag", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the ID of the storage tag", - "name": "id", - "type": "string" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -11652,6 +11718,16 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the name of the storage tag", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the storage tag", + "name": "id", + "type": "string" } ] }, @@ -11676,9 +11752,9 @@ "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -11686,9 +11762,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, {} @@ -11699,6 +11775,14 @@ "isasync": false, "name": "deleteVMSchedule", "params": [ + { + "description": "IDs of VM schedule", + "length": 255, + "name": "ids", + "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "required": false, + "type": "list" + }, { "description": "ID of VM schedule", "length": 255, @@ -11714,14 +11798,6 @@ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, "type": "uuid" - }, - { - "description": "IDs of VM schedule", - "length": 255, - "name": "ids", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", - "required": false, - "type": "list" } ], "response": [ @@ -11736,17 +11812,17 @@ "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.19.0" }, @@ -11766,16 +11842,20 @@ ], "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", "response": [ - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { - "description": "the list of accounts the template is available for", - "name": "account", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template ID", - "name": "id", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { @@ -11789,167 +11869,188 @@ "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 list of accounts the template is available for", + "name": "account", + "type": "list" }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - } + {} ] }, { - "description": "Destroys a system virtual machine.", - "isasync": true, - "name": "destroySystemVm", + "description": "Lists annotations.", + "isasync": false, + "name": "listAnnotations", "params": [ { - "description": "The ID of the system virtual machine", + "description": "", "length": 255, - "name": "id", - "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", - "required": true, - "type": "uuid" - } - ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", - "response": [ - { - "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", + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "optional: the id of the user of the annotation", + "length": 255, + "name": "userid", + "required": false, + "since": "4.16.0", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "possible values are \"self\" and \"all\". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access", + "length": 255, + "name": "annotationfilter", + "required": false, + "since": "4.16.0", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the entity for which to show annotations", + "length": 255, + "name": "entityid", + "required": false, "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the id of the annotation", + "length": 255, + "name": "id", + "required": false, "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the entity type", + "length": 255, + "name": "entitytype", + "required": false, "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "addAnnotation,removeAnnotation,updateAnnotationVisibility", + "response": [ + { + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, + {}, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the contents of the annotation", + "name": "annotation", "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 creation timestamp for this annotation", + "name": "created", + "type": "date" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", + "description": "the removal timestamp for this annotation", + "name": "removed", "type": "date" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" - }, + } + ], + "since": "4.11" + }, + { + "description": "Destroys a system virtual machine.", + "isasync": true, + "name": "destroySystemVm", + "params": [ { - "description": "the ID of the system VM", + "description": "The ID of the system virtual machine", + "length": 255, "name": "id", - "type": "string" - }, + "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "required": true, + "type": "uuid" + } + ], + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "response": [ { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, - {}, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { @@ -11957,220 +12058,202 @@ "name": "hypervisor", "type": "string" }, - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + { + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" + }, { "description": "the network domain for the system VM", "name": "networkdomain", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the state of the system VM", + "name": "state", "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 first DNS for the system VM", - "name": "dns1", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, - {}, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" - } - ] - }, - { - "description": "Lists annotations.", - "isasync": false, - "name": "listAnnotations", - "params": [ + }, { - "description": "optional: the id of the user of the annotation", - "length": 255, - "name": "userid", - "required": false, - "since": "4.16.0", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the id of the annotation", - "length": 255, - "name": "id", - "required": false, + "description": "the systemvm agent version", + "name": "version", "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 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 first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "the entity type", - "length": 255, - "name": "entitytype", - "required": false, + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the id of the entity for which to show annotations", - "length": 255, - "name": "entityid", - "required": false, + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" - } - ], - "related": "addAnnotation,removeAnnotation,updateAnnotationVisibility", - "response": [ + }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" }, - {}, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the (uu)id of the annotation", - "name": "id", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "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" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "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 contents of the annotation", - "name": "annotation", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the system VM", + "name": "name", + "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", + "description": "the last disconnected date of host", + "name": "disconnected", "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" } - ], - "since": "4.11" + ] }, { "description": "Adds Swift.", "isasync": false, "name": "addSwift", "params": [ + { + "description": "the URL for swift", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, { "description": "the account for swift", "length": 255, @@ -12185,13 +12268,6 @@ "required": false, "type": "string" }, - { - "description": "the URL for swift", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, { "description": "the username for swift", "length": 255, @@ -12203,15 +12279,26 @@ "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "response": [ { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, + {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -12227,53 +12314,42 @@ "name": "url", "type": "string" }, + { + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, { "description": "the scope of the image store", "name": "scope", "type": "scopetype" }, - {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, - { - "description": "the provider name of the image store", - "name": "providername", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, - {}, { "description": "defines if store is read-only", "name": "readonly", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - }, - { - "description": "the name of the image store", - "name": "name", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - } + {} ], "since": "3.0.0" }, @@ -12283,9 +12359,17 @@ "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\")", + "description": "the IDs of the events", "length": 255, - "name": "enddate", + "name": "ids", + "related": "listEvents", + "required": false, + "type": "list" + }, + { + "description": "start date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "length": 255, + "name": "startdate", "required": false, "type": "date" }, @@ -12297,31 +12381,28 @@ "type": "string" }, { - "description": "start date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "end date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "startdate", + "name": "enddate", "required": false, "type": "date" - }, - { - "description": "the IDs of the events", - "length": 255, - "name": "ids", - "related": "listEvents", - "required": false, - "type": "list" } ], "response": [ {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -12329,11 +12410,6 @@ "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {} ] }, @@ -12352,28 +12428,28 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on 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.2.0" }, @@ -12383,63 +12459,63 @@ "name": "listUserData", "params": [ { - "description": "the ID of the Userdata", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "listUserData", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of the Userdata", "length": 255, - "name": "page", + "name": "id", + "related": "listUserData", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "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": "uuid" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Userdata name to look for", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Userdata name to look for", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -12449,23 +12525,18 @@ "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "the domain name of the userdata owner", - "name": "domain", - "type": "string" - }, - { - "description": "the owner id of the userdata", - "name": "accountid", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { @@ -12474,47 +12545,52 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "base64 encoded userdata content", + "name": "userdata", + "type": "string" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the owner of the userdata", + "name": "account", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "params", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the owner of the userdata", - "name": "account", + "description": "the domain id of the userdata owner", + "name": "domainid", "type": "string" }, { - "description": "base64 encoded userdata content", - "name": "userdata", + "description": "the owner id of the userdata", + "name": "accountid", "type": "string" }, { - "description": "Name of the userdata", - "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": "params", "type": "string" }, { - "description": "the domain id of the userdata owner", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain name of the userdata owner", + "name": "domain", + "type": "string" }, {}, - {} + {}, + { + "description": "Name of the userdata", + "name": "name", + "type": "string" + } ], "since": "4.18" }, @@ -12543,25 +12619,79 @@ "description": "the ID of the load balancer", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": true, "type": "uuid" } ], "related": "createLoadBalancer,listLoadBalancers", "response": [ + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the domain of the Load Balancer", + "name": "domain", + "type": "string" + }, + { + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + }, + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + } + ], + "type": "list" + }, { "description": "the list of resource tags associated with the Load Balancer", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -12569,14 +12699,19 @@ "name": "resourcetype", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -12585,41 +12720,41 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { "description": "the account associated with the tag", "name": "account", "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" } ], "type": "list" }, { - "description": "is 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": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the project name of the Load Balancer", + "name": "project", + "type": "string" + }, + { + "description": "Load Balancer network id", + "name": "networkid", "type": "string" }, { @@ -12649,68 +12784,14 @@ ], "type": "list" }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "the state of the load balancer rule", - "name": "state", - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the domain of the Load Balancer", - "name": "domain", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, { "description": "the Load Balancer ID", "name": "id", "type": "string" }, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", - "type": "string" - }, - { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { @@ -12719,18 +12800,13 @@ "type": "string" }, { - "description": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "the account of the Load Balancer", + "name": "account", "type": "string" } ], @@ -12742,18 +12818,18 @@ "name": "scaleSystemVm", "params": [ { - "description": "the service offering ID to apply to the system vm", + "description": "The ID of the system vm", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "required": true, "type": "uuid" }, { - "description": "The ID of the system vm", + "description": "the service offering ID to apply to the system vm", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, @@ -12768,36 +12844,19 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - {}, - {}, - { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" - }, - { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { "description": "the control state of the host for the system VM", @@ -12805,14 +12864,14 @@ "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", @@ -12820,53 +12879,34 @@ "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" - }, - { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the state of the system VM", - "name": "state", - "type": "string" - }, - { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" - }, - { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "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 system VM", - "name": "name", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { @@ -12875,23 +12915,23 @@ "type": "list" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { @@ -12900,8 +12940,8 @@ "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -12910,28 +12950,38 @@ "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", + "type": "string" + }, + { + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { @@ -12940,18 +12990,19 @@ "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "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", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { @@ -12960,13 +13011,38 @@ "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" + }, + { + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" + }, + { + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" + }, + { + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { @@ -12975,9 +13051,9 @@ "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 system VM type", + "name": "systemvmtype", + "type": "string" } ] }, @@ -12987,19 +13063,19 @@ "name": "listSnapshotPolicies", "params": [ { - "description": "the ID of the snapshot policy", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createSnapshotPolicy,updateSnapshotPolicy,listSnapshotPolicies", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the ID of the disk volume", "length": 255, - "name": "page", + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -13009,60 +13085,44 @@ "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the ID of the snapshot policy", "length": 255, - "name": "fordisplay", + "name": "id", + "related": "createSnapshotPolicy,updateSnapshotPolicy,listSnapshotPolicies", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the disk volume", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "createSnapshotPolicy,updateSnapshotPolicy", "response": [ { - "description": "the ID of the snapshot policy", - "name": "id", - "type": "string" - }, - { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" - }, - { - "description": "is this policy for display to the regular user", - "name": "fordisplay", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, - {}, - { - "description": "the ID of the disk volume", - "name": "volumeid", + "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" }, {}, @@ -13071,6 +13131,11 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, { "description": "the list of resource tags associated", "name": "tags", @@ -13081,18 +13146,18 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -13101,8 +13166,8 @@ "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" }, { @@ -13111,43 +13176,54 @@ "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 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" } ], "type": "set" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" }, { "description": "The list of zones in which snapshot backup is scheduled", "name": "zone", "type": "set" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } + {} ] }, { @@ -13156,20 +13232,27 @@ "name": "updateVpnCustomerGateway", "params": [ { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "id of customer gateway", "length": 255, - "name": "splitconnections", - "required": false, - "since": "4.15.1", - "type": "boolean" + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "required": true, + "type": "uuid" }, { - "description": "ESP policy of the customer gateway", + "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "esppolicy", + "name": "cidrlist", "required": true, "type": "string" }, + { + "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "Force encapsulation for Nat Traversal", "length": 255, @@ -13178,20 +13261,18 @@ "type": "boolean" }, { - "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", + "description": "public ip address id of the customer gateway", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "name": "gateway", + "required": true, + "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "ikeversion", + "name": "ikelifetime", "required": false, - "since": "4.15.1", - "type": "string" + "type": "long" }, { "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", @@ -13201,66 +13282,61 @@ "type": "string" }, { - "description": "IKE policy of the customer gateway", + "description": "ESP policy of the customer gateway", "length": 255, - "name": "ikepolicy", + "name": "esppolicy", "required": true, "type": "string" }, { - "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "cidrlist", - "required": true, - "type": "string" + "name": "esplifetime", + "required": false, + "type": "long" }, { - "description": "name of this customer gateway", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", "length": 255, - "name": "name", + "name": "ikeversion", "required": false, + "since": "4.15.1", "type": "string" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "description": "name of this customer gateway", "length": 255, - "name": "esplifetime", + "name": "name", "required": false, - "type": "long" + "type": "string" }, { - "description": "If DPD is enabled for VPN connection", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "dpd", + "name": "splitconnections", "required": false, + "since": "4.15.1", "type": "boolean" }, { - "description": "id of customer gateway", - "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", - "required": true, - "type": "uuid" - }, - { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "ikelifetime", + "name": "dpd", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "public ip address id of the customer gateway", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "gateway", + "name": "ikepolicy", "required": true, "type": "string" } @@ -13268,40 +13344,28 @@ "related": "createVpnCustomerGateway,listVpnCustomerGateways", "response": [ { - "description": "the project name", - "name": "project", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - {}, - { - "description": "the owner", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -13315,34 +13379,24 @@ "type": "boolean" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "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", @@ -13350,13 +13404,13 @@ "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the project id", + "name": "projectid", "type": "string" }, { @@ -13365,23 +13419,45 @@ "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 domain name of the owner", - "name": "domain", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "guest ip of the customer gateway", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "name of the customer gateway", + "name": "name", "type": "string" } ] @@ -13392,18 +13468,18 @@ "name": "verifyOAuthCodeAndGetUser", "params": [ { - "description": "List by keyword", + "description": "Name of the provider", "length": 255, - "name": "keyword", - "required": false, + "name": "provider", + "required": true, "type": "string" }, { - "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "description": "", "length": 255, - "name": "secretcode", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -13413,51 +13489,35 @@ "type": "integer" }, { - "description": "Name of the provider", + "description": "List by keyword", "length": 255, - "name": "provider", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "", + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", "length": 255, - "name": "page", + "name": "secretcode", "required": false, - "type": "integer" + "type": "string" } ], "related": "updateOauthProvider", "response": [ - { - "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": "Description of the provider registered", "name": "description", "type": "string" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", - "type": "boolean" - }, - { - "description": "ID of the provider", - "name": "id", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" }, { @@ -13465,21 +13525,37 @@ "name": "jobid", "type": "string" }, + {}, + { + "description": "Name of the provider", + "name": "provider", + "type": "string" + }, + {}, { "description": "Name of the provider", "name": "name", "type": "string" }, + { + "description": "ID of the provider", + "name": "id", + "type": "string" + }, { "description": "Redirect URI registered in the OAuth provider", "name": "redirecturi", "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", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.19.0" @@ -13503,13 +13579,6 @@ "required": false, "type": "list" }, - { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": false, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -13538,45 +13607,57 @@ "name": "policyuuid", "required": false, "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, + "type": "string" } ], "related": "createTungstenFabricTag,removeTungstenFabricTag", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { "description": "Tungsten-Fabric 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 vm", "name": "vm", "type": "list" }, + {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, + {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { @@ -13585,14 +13666,9 @@ "type": "list" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" - }, - { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" } ] }, @@ -13610,16 +13686,16 @@ "type": "uuid" }, { - "description": "the name for the object store", + "description": "the url for the object store", "length": 255, - "name": "name", + "name": "url", "required": false, "type": "string" }, { - "description": "the url for the object store", + "description": "the name for the object store", "length": 255, - "name": "url", + "name": "name", "required": false, "type": "string" } @@ -13627,13 +13703,8 @@ "related": "addObjectStoragePool,listObjectStoragePools", "response": [ { - "description": "the provider name of the object store", - "name": "providername", - "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" }, { @@ -13641,6 +13712,11 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the name of the object store", + "name": "name", + "type": "string" + }, { "description": "the total size of the object store", "name": "storagetotal", @@ -13651,28 +13727,28 @@ "name": "storageused", "type": "long" }, - { - "description": "the name of the object store", - "name": "name", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - {}, - {}, { "description": "the url of the object store", "name": "url", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the provider name of the object store", + "name": "providername", "type": "string" - } + }, + {}, + { + "description": "the ID of the object store", + "name": "id", + "type": "string" + }, + {} ], "since": "4.19.0" }, @@ -13682,27 +13758,26 @@ "name": "listClusterDrsPlan", "params": [ { - "description": "ID of the drs plan", + "description": "", "length": 255, - "name": "id", - "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "ID of the cluster", + "description": "List by keyword", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "ID of the cluster", "length": 255, - "name": "keyword", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -13712,27 +13787,20 @@ "type": "integer" }, { - "description": "", + "description": "ID of the drs plan", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "generateClusterDrsPlan,executeClusterDrsPlan", "response": [ - {}, - { - "description": "List of migrations", - "name": "migrations", - "type": "list" - }, - {}, - {}, { - "description": "unique ID of the drs plan for cluster", - "name": "id", - "type": "string" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, { "description": "Start event Id of the DRS Plan", @@ -13740,13 +13808,8 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, { @@ -13754,15 +13817,28 @@ "name": "clusterid", "type": "string" }, + {}, + {}, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Status of DRS Plan", "name": "status", "type": "status" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "List of migrations", + "name": "migrations", + "type": "list" } ], "since": "4.19.0" @@ -13773,62 +13849,67 @@ "name": "lockAccount", "params": [ { - "description": "Locks the specified account on this domain.", + "description": "Locks the specified account.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "account", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Locks the specified account.", + "description": "Locks the specified account on this domain.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": true, - "type": "string" + "type": "uuid" } ], "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ { - "description": "the name of the account", - "name": "name", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" }, { "description": "the total primary storage space (in GiB) owned by account", @@ -13841,73 +13922,79 @@ "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "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 total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the state of the account", + "name": "state", + "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, + {}, { "description": "the total number of networks the account can own", "name": "networklimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { @@ -13916,89 +14003,73 @@ "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", "type": "integer" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, - {}, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { @@ -14007,28 +14078,48 @@ "type": "list" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { @@ -14036,9 +14127,10 @@ "name": "vmstopped", "type": "integer" }, + {}, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { @@ -14046,9 +14138,9 @@ "name": "user", "response": [ { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { "description": "the domain ID of the user", @@ -14056,19 +14148,14 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { "description": "the type of the role", @@ -14076,34 +14163,19 @@ "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the user state", - "name": "state", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the ID of the role", @@ -14111,25 +14183,15 @@ "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the user lastname", - "name": "lastname", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user email address", + "name": "email", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the date and time the user account was created", "name": "created", @@ -14146,77 +14208,91 @@ "type": "boolean" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" }, { "description": "the api key of the user", "name": "apikey", "type": "string" }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, { "description": "the account name of the user", "name": "account", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the name of the role", + "name": "rolename", "type": "string" } ], "type": "list" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "the total memory (in MB) 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 state of the account", - "name": "state", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" } ] @@ -14245,124 +14321,42 @@ "related": "destroyRouter,listRouters,rebootRouter,startRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, { "description": "the ID of the corresponding guest network", "name": "guestnetworkid", "type": "string" }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -14370,65 +14364,75 @@ "name": "ipaddresses", "type": "list" }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, { "description": "ID of the VLAN/VNI if available", "name": "vlanid", "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the nic", + "name": "id", "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 ID of the corresponding network", - "name": "networkid", - "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { "description": "device id for the network when plugged into the virtual machine", @@ -14436,273 +14440,345 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "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 ID of the nic", - "name": "id", + "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 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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, {}, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, { "description": "the guest IP address for the router", "name": "guestipaddress", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, { "description": "the guest netmask for the router", "name": "guestnetmask", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, - {}, { - "description": "the account associated with the router", - "name": "account", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "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 project name of the address", - "name": "project", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", "type": "string" } ] @@ -14713,26 +14789,26 @@ "name": "listClusters", "params": [ { - "description": "lists clusters by hypervisor type", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "hypervisor", + "name": "managedstate", "required": false, "type": "string" }, { - "description": "lists clusters by Pod ID", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "showcapacities", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "flag to display the capacity of the clusters", + "description": "lists clusters by Zone ID", "length": 255, - "name": "showcapacities", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List by keyword", @@ -14749,11 +14825,20 @@ "type": "integer" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "managedstate", + "name": "id", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "lists clusters by Pod ID", + "length": 255, + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { "description": "lists clusters by allocation state", @@ -14763,12 +14848,11 @@ "type": "string" }, { - "description": "lists clusters by the cluster ID", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "id", - "related": "addCluster,listClusters,updateCluster", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -14790,77 +14874,80 @@ "name": "clustertype", "required": false, "type": "string" - }, - { - "description": "lists clusters by Zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" } ], "related": "addCluster,updateCluster", "response": [ { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, {}, + { + "description": "the Zone name of the cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Meta data associated with the zone (key/value pairs)", "name": "resourcedetails", "type": "map" }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, { "description": "the cluster ID", "name": "id", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the cluster name", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -14868,33 +14955,33 @@ "name": "capacity", "response": [ { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Zone name", + "name": "zonename", + "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Pod ID", + "name": "podid", + "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -14903,19 +14990,19 @@ "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the Pod name", - "name": "podname", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { "description": "the Zone ID", @@ -14923,37 +15010,26 @@ "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" } ] @@ -14973,28 +15049,28 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, - {}, { "description": "the 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": "3.0.0" }, @@ -15004,18 +15080,12 @@ "name": "listProjectInvitations", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "list by project id", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", @@ -15024,14 +15094,6 @@ "required": false, "type": "boolean" }, - { - "description": "list by project id", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -15040,10 +15102,10 @@ "type": "integer" }, { - "description": "list invitation by user ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, @@ -15063,19 +15125,19 @@ "type": "boolean" }, { - "description": "list invitations by state", + "description": "list invitation by user ID", "length": 255, - "name": "state", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "string" + "type": "uuid" }, { - "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -15084,6 +15146,20 @@ "required": false, "type": "boolean" }, + { + "description": "list invitations by state", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -15095,30 +15171,29 @@ "related": "", "response": [ { - "description": "the account name of the project's owner", - "name": "account", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, + {}, { - "description": "the name of the project", - "name": "project", + "description": "the account name of the project's owner", + "name": "account", "type": "string" }, - {}, { "description": "the email the invitation was sent to", "name": "email", "type": "string" }, - {}, { - "description": "the id of the invitation", - "name": "id", + "description": "the User ID", + "name": "userid", "type": "string" }, { - "description": "the User ID", - "name": "userid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -15126,26 +15201,27 @@ "name": "domain", "type": "string" }, + { + "description": "the id of the invitation", + "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 domain id the project belongs to", - "name": "domainid", + "description": "the invitation state", + "name": "state", "type": "string" }, { - "description": "the invitation state", - "name": "state", + "description": "the name of the project", + "name": "project", "type": "string" }, + {}, { "description": "the id of the project", "name": "projectid", @@ -15159,6 +15235,13 @@ "isasync": true, "name": "createTungstenFabricFirewallPolicy", "params": [ + { + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, + "type": "string" + }, { "description": "the ID of zone", "length": 255, @@ -15174,13 +15257,6 @@ "required": true, "type": "string" }, - { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": false, - "type": "string" - }, { "description": "the sequence of Tungsten-Fabric firewall policy", "length": 255, @@ -15192,20 +15268,11 @@ "related": "listTungstenFabricFirewallPolicy", "response": [ { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "Tungsten-Fabric firewall policy uuid", - "name": "uuid", + "description": "Tungsten-Fabric firewall policy name", + "name": "name", "type": "string" }, - { - "description": "list Tungsten-Fabric firewall rule", - "name": "firewallrule", - "type": "list" - }, + {}, {}, { "description": "the current status of the latest async job acting on this object", @@ -15213,20 +15280,29 @@ "type": "integer" }, { - "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": "Tungsten-Fabric firewall policy name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall policy uuid", + "name": "uuid", "type": "string" + }, + { + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" } ] }, @@ -15236,26 +15312,10 @@ "name": "listEgressFirewallRules", "params": [ { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "Lists rule with the specified ID.", + "description": "the network ID for the egress firewall services", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, @@ -15274,26 +15334,26 @@ "type": "boolean" }, { - "description": "the ID of IP address of the firewall services", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -15304,18 +15364,27 @@ "type": "boolean" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "account", + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "string" + "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": "List resources by tags (key/value pairs)", @@ -15325,22 +15394,54 @@ "type": "map" }, { - "description": "the network ID for the egress firewall services", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": false, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", "response": [ - {}, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" + }, { "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", @@ -15352,29 +15453,39 @@ "type": "integer" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", "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", @@ -15386,18 +15497,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -15406,73 +15517,38 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - {}, { "description": "the ID of the firewall rule", "name": "id", "type": "string" }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, + {}, { "description": "the network id of the firewall rule", "name": "networkid", "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -15482,16 +15558,16 @@ "name": "updateRegion", "params": [ { - "description": "updates region with this name", + "description": "updates region with this end point", "length": 255, - "name": "name", + "name": "endpoint", "required": false, "type": "string" }, { - "description": "updates region with this end point", + "description": "updates region with this name", "length": 255, - "name": "endpoint", + "name": "name", "required": false, "type": "string" }, @@ -15510,37 +15586,37 @@ "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" + }, { "description": "the name of the region", "name": "name", "type": "string" }, {}, + {}, { "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -15559,28 +15635,28 @@ } ], "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "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": "3.0.0" }, @@ -15590,26 +15666,20 @@ "name": "listClustersMetrics", "params": [ { - "description": "flag to display the capacity of the clusters", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "showcapacities", + "name": "id", + "related": "addCluster,updateCluster", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "keyword", + "name": "hypervisor", "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "lists clusters by Zone ID", "length": 255, @@ -15619,40 +15689,32 @@ "type": "uuid" }, { - "description": "lists clusters by the cluster ID", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, - { - "description": "lists clusters by allocation state", + "description": "lists clusters by cluster type", "length": 255, - "name": "allocationstate", + "name": "clustertype", "required": false, "type": "string" }, { - "description": "lists clusters by the cluster name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "lists clusters by cluster type", + "description": "", "length": 255, - "name": "clustertype", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "", "length": 255, - "name": "managedstate", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "lists clusters by Pod ID", @@ -15663,35 +15725,80 @@ "type": "uuid" }, { - "description": "lists clusters by hypervisor type", + "description": "lists clusters by allocation state", "length": 255, - "name": "hypervisor", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "pagesize", + "name": "managedstate", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "flag to display the capacity of the clusters", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" + }, + { + "description": "lists clusters by the cluster name", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "", "response": [ + { + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", + "type": "string" + }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" + }, + {}, + { + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" + }, + { + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" + }, { "description": "the total cpu used in Ghz", "name": "cpuused", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { @@ -15699,14 +15806,9 @@ "name": "capacity", "response": [ { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the capacity type", @@ -15714,18 +15816,18 @@ "type": "short" }, { - "description": "the Pod ID", - "name": "podid", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the Pod name", - "name": "podname", + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -15734,66 +15836,51 @@ "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Pod name", + "name": "podname", + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Pod ID", + "name": "podid", + "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", "type": "string" } ], "type": "list" }, { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" - }, - { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", - "type": "string" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { @@ -15802,126 +15889,115 @@ "type": "string" }, { - "description": "running / total hosts in the cluster", - "name": "hosts", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, + {}, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "the total cpu used in GiB", + "name": "memoryused", "type": "string" }, - {}, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", "type": "boolean" }, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "running / total hosts in the cluster", + "name": "hosts", "type": "string" }, - {}, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", + "description": "state of the cluster", + "name": "state", "type": "string" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", - "type": "string" + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" }, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "state of the cluster", - "name": "state", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" } ], "since": "4.9.3" @@ -15931,13 +16007,6 @@ "isasync": false, "name": "listStoragePoolObjects", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "path to list on storage pool", "length": 255, @@ -15953,11 +16022,11 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "id of the storage pool", @@ -15966,45 +16035,46 @@ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "listImageStoreObjects", "response": [ { - "description": "Is it a directory.", - "name": "isdirectory", - "type": "boolean" - }, - { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "description": "Format of template associated with the data store object.", + "name": "format", "type": "string" }, { - "description": "Template ID associated with the data store object.", - "name": "templateid", - "type": "string" + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" }, {}, { - "description": "Format of template associated with the data store object.", - "name": "format", + "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": "Name of the data store object.", + "name": "name", "type": "string" }, { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "Size is in Bytes.", + "name": "size", + "type": "long" }, { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", "type": "string" }, { @@ -16012,15 +16082,21 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "Name of the data store object.", - "name": "name", + "description": "Template ID associated with the data store object.", + "name": "templateid", "type": "string" }, { - "description": "Size is in Bytes.", - "name": "size", - "type": "long" + "description": "Volume ID associated with the data store object.", + "name": "volumeid", + "type": "string" + }, + { + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" } ], "since": "4.19.0" @@ -16030,14 +16106,6 @@ "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, @@ -16045,35 +16113,37 @@ "related": "createProjectRole,listProjectRoles,updateProjectRole", "required": false, "type": "uuid" + }, + { + "description": "ID of the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" } ], "related": "createProjectRolePermission", "response": [ { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the ID of the project", + "name": "projectid", "type": "string" }, - {}, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the description of the role permission", - "name": "description", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { @@ -16082,8 +16152,8 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { @@ -16092,9 +16162,15 @@ "type": "string" }, { - "description": "the ID of the project", - "name": "projectid", + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.15.0" @@ -16105,18 +16181,18 @@ "name": "listLdapConfigurations", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Hostname", + "description": "", "length": 255, - "name": "hostname", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", @@ -16127,47 +16203,46 @@ "type": "boolean" }, { - "description": "", + "description": "Port", "length": 255, - "name": "page", + "name": "port", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "Hostname", "length": 255, - "name": "keyword", + "name": "hostname", "required": false, "type": "string" }, { - "description": "linked domain", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Port", + "description": "linked domain", "length": 255, - "name": "port", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "addLdapConfiguration,deleteLdapConfiguration", "response": [ - {}, {}, { - "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": "linked domain", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -16175,15 +16250,16 @@ "name": "hostname", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "linked domain", + "name": "domainid", "type": "string" }, { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.2.0" @@ -16194,27 +16270,26 @@ "name": "listSecondaryStagingStores", "params": [ { - "description": "the ID of the staging store", + "description": "the Zone ID for the staging store", "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the Zone ID for the staging store", + "description": "the name of the staging store", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "the staging store provider", @@ -16231,23 +16306,24 @@ "type": "integer" }, { - "description": "the name of the staging store", + "description": "the ID of the staging store", "length": 255, - "name": "name", + "name": "id", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the staging store protocol", + "description": "", "length": 255, - "name": "protocol", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "the staging store protocol", "length": 255, - "name": "keyword", + "name": "protocol", "required": false, "type": "string" } @@ -16255,54 +16331,65 @@ "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "response": [ { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, - {}, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the url of the image store", - "name": "url", + "description": "the ID of the image store", + "name": "id", "type": "string" }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + {}, + {}, { "description": "the scope of the image store", "name": "scope", "type": "scopetype" }, { - "description": "the name of the image store", - "name": "name", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "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" }, { @@ -16310,21 +16397,10 @@ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.2.0" @@ -16335,34 +16411,34 @@ "name": "createRemoteAccessVpn", "params": [ { - "description": "an optional account for the VPN. Must be used with domainId.", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", + "description": "an optional account for the VPN. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "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": "fordisplay", + "name": "openfirewall", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", + "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "openfirewall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "public ip address id of the vpn server", @@ -16383,33 +16459,34 @@ "related": "listRemoteAccessVpns,updateRemoteAccessVpn", "response": [ { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the account of the remote access vpn", + "name": "account", + "type": "string" }, + {}, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { @@ -16418,19 +16495,24 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, - {}, { "description": "the domain id of the account of the remote access vpn", "name": "domainid", "type": "string" }, + {}, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the id of the remote access vpn", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -16439,20 +16521,14 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the rule", + "name": "state", "type": "string" }, - {}, { "description": "the public ip address of the vpn server", "name": "publicip", "type": "string" - }, - { - "description": "the ipsec preshared key", - "name": "presharedkey", - "type": "string" } ] }, @@ -16472,14 +16548,15 @@ ], "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ + {}, { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { @@ -16488,70 +16565,29 @@ "type": "string" }, { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { @@ -16560,34 +16596,18 @@ "type": "state" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { @@ -16596,53 +16616,48 @@ "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the 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 ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -16651,13 +16666,8 @@ "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -16665,28 +16675,28 @@ "name": "nic", "response": [ { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the nic", + "name": "id", "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 gateway of the nic", - "name": "gateway", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -16695,28 +16705,38 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "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", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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" }, { @@ -16725,23 +16745,23 @@ "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -16750,54 +16770,54 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the 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", + "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { "description": "MTU configured on the NIC", @@ -16805,86 +16825,81 @@ "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", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" } ], "type": "set" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "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 ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { @@ -16892,20 +16907,29 @@ "name": "requiresupgrade", "type": "boolean" }, - {}, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -16914,23 +16938,75 @@ "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the host ID for the router", + "name": "hostid", + "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", "type": "string" } ] @@ -16940,6 +17016,22 @@ "isasync": false, "name": "changeServiceForVirtualMachine", "params": [ + { + "description": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.17", + "type": "long" + }, + { + "description": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, + "since": "4.17", + "type": "boolean" + }, { "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, @@ -16956,12 +17048,12 @@ "type": "boolean" }, { - "description": "Verify OK to Shrink", + "description": "the service offering ID to apply to the virtual machine", "length": 255, - "name": "shrinkok", - "required": false, - "since": "4.17", - "type": "boolean" + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { "description": "The ID of the virtual machine", @@ -16978,44 +17070,33 @@ "required": false, "since": "4.17", "type": "long" - }, - { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.17", - "type": "long" - }, - { - "description": "the service offering ID to apply to the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" } ], "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "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" }, { @@ -17024,103 +17105,109 @@ "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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 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 user's ID who deployed the virtual machine", - "name": "userid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "OS type id of the vm", + "name": "ostypeid", "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": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, + {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { @@ -17129,500 +17216,171 @@ "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, - {}, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the 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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "Guest vm Boot Type", + "name": "boottype", + "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 description of the affinity group", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - {}, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the 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 field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "ssh key-pairs", @@ -17630,88 +17388,74 @@ "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, + {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "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": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { @@ -17719,90 +17463,80 @@ "name": "nic", "response": [ { - "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 netmask of the nic", - "name": "netmask", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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 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 isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "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", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, { "description": "the ID of the corresponding network", "name": "networkid", @@ -17810,13 +17544,13 @@ }, { "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "name": "macaddress", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "the type of the nic", @@ -17824,290 +17558,637 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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 IPv6 address of network", - "name": "ip6address", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 gateway of the nic", - "name": "gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" } ], "type": "set" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - {}, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "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": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "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 project name where tag belongs to", - "name": "project", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "tag value", - "name": "value", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the description of the affinity group", + "name": "description", "type": "string" } ], "type": "set" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" - } - ] - }, - { - "description": "Resets a configuration. The configuration will be set to default value for global setting, and removed from account_details or domain_details for Account/Domain settings", - "isasync": false, - "name": "resetConfiguration", - "params": [ + }, { - "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 state of the virtual machine", + "name": "state", + "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 account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the name of the configuration", - "length": 255, - "name": "name", - "required": true, + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the ID of the Zone to reset the parameter value for corresponding zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "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 ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the ID of the Image Store to reset the parameter value for corresponding image store", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the 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 resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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" + } + ], + "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 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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the 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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the 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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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 id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "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 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 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 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 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" + }, + { + "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 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 name of the configuration", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "listConfigurations,updateConfiguration", "response": [ { - "description": "the type of the configuration value", - "name": "type", + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" + }, + { + "description": "the type of the configuration value", + "name": "type", "type": "string" }, + {}, { - "description": "the value of the configuration", - "name": "value", + "description": "the component of the configuration", + "name": "component", "type": "string" }, { @@ -18115,55 +18196,55 @@ "name": "scope", "type": "string" }, + {}, { - "description": "the component of the configuration", - "name": "component", + "description": "the description of the configuration", + "name": "description", "type": "string" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the group of the configuration", + "name": "group", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", - "type": "string" + "description": "the value of the configuration", + "name": "id", + "type": "long" }, { - "description": "the name of the configuration", - "name": "name", + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, - {}, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the description of the configuration", - "name": "description", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the possible options of the configuration value", + "name": "options", + "type": "string" }, { - "description": "the group of the configuration", - "name": "group", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { @@ -18172,14 +18253,9 @@ "type": "integer" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" - }, - { - "description": "the value of the configuration", - "name": "id", - "type": "long" } ], "since": "4.16.0" @@ -18189,13 +18265,6 @@ "isasync": false, "name": "listGuestOsMapping", "params": [ - { - "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", - "length": 255, - "name": "hypervisorversion", - "required": false, - "type": "string" - }, { "description": "list mapping by its UUID", "length": 255, @@ -18207,7 +18276,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -18219,16 +18288,16 @@ "type": "string" }, { - "description": "list Guest OS mapping by OS mapping name with hypervisor", + "description": "list Guest OS mapping by OS display name", "length": 255, - "name": "osnameforhypervisor", + "name": "osdisplayname", "required": false, "type": "string" }, { - "description": "list Guest OS mapping by hypervisor", + "description": "list Guest OS mapping by OS mapping name with hypervisor", "length": 255, - "name": "hypervisor", + "name": "osnameforhypervisor", "required": false, "type": "string" }, @@ -18241,41 +18310,42 @@ "type": "uuid" }, { - "description": "list Guest OS mapping by OS display name", + "description": "", "length": 255, - "name": "osdisplayname", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list Guest OS mapping by hypervisor", + "length": 255, + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "", + "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", "length": 255, - "name": "page", + "name": "hypervisorversion", "required": false, - "type": "integer" + "type": "string" } ], "related": "addGuestOsMapping,updateGuestOsMapping", "response": [ { - "description": "the ID of the Guest OS mapping", - "name": "id", - "type": "string" - }, - { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, - {}, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the ID of the Guest OS mapping", + "name": "id", "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { @@ -18283,10 +18353,11 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the ID of the Guest OS type", @@ -18294,15 +18365,20 @@ "type": "string" }, {}, + { + "description": "is the mapping user defined", + "name": "isuserdefined", + "type": "string" + }, { "description": "the hypervisor", "name": "hypervisor", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", + "type": "string" } ], "since": "4.4.0" @@ -18313,27 +18389,27 @@ "name": "listTemplates", "params": [ { - "description": "the hypervisor for which to restrict the search", + "description": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "hypervisor", + "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, - "type": "string" + "since": "4.9", + "type": "list" }, { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isvnf", + "name": "account", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "string" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "description": "", "length": 255, - "name": "details", + "name": "page", "required": false, - "since": "4.15", - "type": "list" + "type": "integer" }, { "description": "List resources by tags (key/value pairs)", @@ -18343,87 +18419,96 @@ "type": "map" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "page", + "name": "showunique", "required": false, - "type": "integer" + "since": "4.13.2", + "type": "boolean" }, { - "description": "show removed templates as well", + "description": "ID of the storage pool", "length": 255, - "name": "showremoved", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "boolean" + "since": "4.19", + "type": "uuid" }, { - "description": "If set to true, list only unique templates across zones", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "showunique", + "name": "hypervisor", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "string" }, { - "description": "the template ID", + "description": "list datadisk templates by parent template id", "length": 255, - "name": "id", + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "comma separated list of template details requested, value can be a list of [ all, min]", "length": 255, - "name": "listall", + "name": "details", "required": false, - "type": "boolean" + "since": "4.15", + "type": "list" }, { - "description": "the IDs of the templates, mutually exclusive with id", + "description": "List by keyword", "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", + "name": "keyword", "required": false, - "since": "4.9", - "type": "list" + "type": "string" }, { - "description": "list datadisk templates by parent template id", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "parenttemplateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "flag to display the resource image for the templates", "length": 255, - "name": "isrecursive", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "", + "description": "the template name", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", "length": 255, - "name": "templatefilter", - "required": true, - "type": "string" + "name": "isvnf", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "show removed templates as well", + "length": 255, + "name": "showremoved", + "required": false, + "type": "boolean" }, { "description": "the type of the template", @@ -18434,109 +18519,111 @@ "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list templates by zoneId", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "ID of the image or image cache store", + "description": "the template ID", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "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, - "since": "4.19", "type": "uuid" }, { - "description": "list templates by zoneId", + "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", "required": false, "type": "uuid" }, { - "description": "the template name", + "description": "ID of the image or image cache store", "length": 255, - "name": "name", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "required": false, - "type": "string" + "since": "4.19", + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "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": "account", - "required": false, + "name": "templatefilter", + "required": true, "type": "string" }, { - "description": "flag to display the resource image for the templates", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "showicon", + "name": "isrecursive", "required": false, "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" } ], "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "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": "the name of the domain to which the template belongs", - "name": "domain", + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + {}, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { @@ -18544,23 +18631,93 @@ "name": "userdataid", "type": "string" }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, { "description": "the date this template was created", "name": "created", "type": "date" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "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", "type": "string" }, { @@ -18569,103 +18726,82 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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": "the ID of the domain to which the template belongs", - "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 template", - "name": "project", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", + "description": "additional key/value details tied with template", + "name": "details", "type": "map" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - {}, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { "description": "the size of the template", @@ -18673,23 +18809,24 @@ "type": "long" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, + {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { @@ -18698,70 +18835,54 @@ "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "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 name of userdata linked to this template", - "name": "userdataname", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, - {}, { - "description": "the template ID", - "name": "id", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "checksum of the template", - "name": "checksum", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { "description": "if root disk template, then ids of the datas disk templates this template owns", @@ -18769,73 +18890,29 @@ "type": "set" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" - }, + } + ] + }, + { + "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": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" - }, - { - "description": "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": "the account name to which the template belongs", - "name": "account", - "type": "string" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" - } - ] - }, - { - "description": "Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group.", - "isasync": true, - "name": "createAutoScalePolicy", - "params": [ - { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", + "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, - "name": "quiettime", - "required": false, - "type": "integer" + "name": "conditionids", + "related": "createCondition,listConditions", + "required": true, + "type": "list" }, { "description": "the name of the autoscale policy", @@ -18860,82 +18937,81 @@ "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "conditionids", - "related": "createCondition,listConditions", - "required": true, - "type": "list" + "name": "quiettime", + "required": false, + "type": "integer" } ], "related": "listAutoScalePolicies,updateAutoScalePolicy", "response": [ + {}, { - "description": "name of the autoscale policy", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" }, { - "description": "the account owning the autoscale policy", - "name": "account", - "type": "string" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "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 list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, { - "description": "the autoscale policy ID", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, - {}, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "name of the autoscale policy", + "name": "name", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", + "type": "string" } ] }, @@ -18948,29 +19024,29 @@ "description": "the host ID of ssp server", "length": 255, "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": true, "type": "uuid" } ], "response": [ + {}, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -19002,27 +19078,28 @@ "related": "listTungstenFabricPolicy,removeTungstenFabricPolicyRule,applyTungstenFabricPolicy,removeTungstenFabricPolicy", "response": [ {}, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "Tungsten-Fabric policy name", "name": "name", "type": "string" }, - {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -19033,11 +19110,10 @@ "name": "network", "type": "list" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" } ] }, @@ -19048,43 +19124,43 @@ "params": [], "related": "", "response": [ - { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" - }, { "description": "the name of the active usage server", "name": "hostname", "type": "string" }, - {}, { - "description": "the last time this Usage Server checked for jobs", - "name": "lastheartbeat", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the 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 state of the usage server", "name": "state", "type": "state" }, + {}, { - "description": "the last time a usage job successfully completed", - "name": "lastsuccessfuljob", + "description": "the time these statistics were collected", + "name": "collectiontime", "type": "date" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.17.0" }, @@ -19093,6 +19169,27 @@ "isasync": true, "name": "createBucket", "params": [ + { + "description": "the account associated with the bucket. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Enable bucket versioning", + "length": 255, + "name": "versioning", + "required": false, + "type": "boolean" + }, + { + "description": "the name of the bucket", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "Id of the Object Storage Pool where bucket is created", "length": 255, @@ -19108,13 +19205,6 @@ "required": false, "type": "boolean" }, - { - "description": "The Bucket access policy", - "length": 255, - "name": "policy", - "required": false, - "type": "string" - }, { "description": "Bucket Quota in GB", "length": 255, @@ -19123,24 +19213,26 @@ "type": "integer" }, { - "description": "the account associated with the bucket. Must be used with the domainId parameter.", + "description": "the project associated with the bucket. Mutually exclusive with account parameter", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Enable bucket versioning", + "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": "versioning", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the name of the bucket", + "description": "The Bucket access policy", "length": 255, - "name": "name", - "required": true, + "name": "policy", + "required": false, "type": "string" }, { @@ -19149,78 +19241,126 @@ "name": "objectlocking", "required": false, "type": "boolean" - }, - { - "description": "the domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "description": "the project associated with the bucket. Mutually exclusive with account parameter", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" } ], "related": "listBuckets", "response": [ + {}, + { + "description": "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": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" + }, + { + "description": "the ID of the domain associated with the bucket", + "name": "domainid", + "type": "string" + }, { "description": "the domain associated with the bucket", "name": "domain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "name of the Bucket", + "name": "name", + "type": "string" }, { - "description": "Bucket Secret Key", - "name": "usersecretkey", + "description": "the date the Bucket was created", + "name": "created", + "type": "date" + }, + { + "description": "Bucket URL", + "name": "url", "type": "string" }, - {}, { - "description": "the account associated with the Bucket", - "name": "account", + "description": "State of the Bucket", + "name": "state", "type": "string" }, { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", + "description": "Bucket Access Key", + "name": "accesskey", "type": "string" }, { - "description": "Bucket Object Locking", - "name": "objectlocking", - "type": "boolean" + "description": "the project name of the bucket", + "name": "project", + "type": "string" + }, + { + "description": "Bucket Secret Key", + "name": "usersecretkey", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "Bucket URL", - "name": "url", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the bucket", + "name": "projectid", "type": "string" }, { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" }, { "description": "Name of the object storage hosting the Bucket; returned to admin user only", "name": "objectstore", "type": "string" }, + { + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" + }, + { + "description": "ID of the Bucket", + "name": "id", + "type": "string" + }, + { + "description": "Bucket Access Policy", + "name": "policy", + "type": "string" + }, + { + "description": "the account associated with the Bucket", + "name": "account", + "type": "string" + }, + { + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" + }, { "description": "Bucket Quota in GB", "name": "quota", @@ -19231,48 +19371,48 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the 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": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -19283,71 +19423,7 @@ ], "type": "set" }, - { - "description": "ID of the Bucket", - "name": "id", - "type": "string" - }, - { - "description": "id of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstorageid", - "type": "string" - }, - { - "description": "State of the Bucket", - "name": "state", - "type": "string" - }, - { - "description": "Bucket Access Key", - "name": "accesskey", - "type": "string" - }, - { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" - }, - { - "description": "the project id of the bucket", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the bucket", - "name": "project", - "type": "string" - }, - { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" - }, - { - "description": "Bucket Access Policy", - "name": "policy", - "type": "string" - }, - { - "description": "Bucket Versioning", - "name": "versioning", - "type": "boolean" - }, - { - "description": "Object storage provider", - "name": "provider", - "type": "string" - }, - { - "description": "name of the Bucket", - "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" }, @@ -19356,6 +19432,20 @@ "isasync": false, "name": "listPhysicalNetworks", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "the Zone ID for the physical network", "length": 255, @@ -19365,11 +19455,12 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "list physical network by id", "length": 255, - "name": "keyword", + "name": "id", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { "description": "search by name", @@ -19384,59 +19475,49 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list physical network by id", - "length": 255, - "name": "id", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" } ], "related": "createPhysicalNetwork,updatePhysicalNetwork", "response": [ { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain id of the physical network owner", + "name": "domainid", + "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "comma separated tag", + "name": "tags", "type": "string" }, - {}, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { @@ -19444,9 +19525,10 @@ "name": "isolationmethods", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the physical network", + "name": "name", "type": "string" }, { @@ -19455,19 +19537,13 @@ "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", - "type": "string" - }, - {}, - { - "description": "comma separated tag", - "name": "tags", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" } ], @@ -19488,11 +19564,6 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "true if operation is executed successfully", @@ -19500,15 +19571,20 @@ "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "4.11" @@ -19519,19 +19595,29 @@ "name": "listFirewallRules", "params": [ { - "description": "the ID of IP address of the firewall services", + "description": "list firewall rules for certain network", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.3", "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "tags", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "map" + "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": "List by keyword", @@ -19541,27 +19627,33 @@ "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "list firewall rules for certain network", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": false, - "since": "4.3", "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { "description": "", @@ -19579,118 +19671,73 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "description": "Lists rule with the specified ID.", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createFirewallRule,updateEgressFirewallRule", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the ending port of firewall rule's port range", + "name": "endport", "type": "integer" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "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 public ip address for the firewall rule", - "name": "ipaddress", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, { "description": "is rule for display to the regular user", "name": "fordisplay", "type": "boolean" }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -19699,8 +19746,8 @@ "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" }, { @@ -19708,42 +19755,42 @@ "name": "customer", "type": "string" }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { "description": "id of the resource", "name": "resourceid", "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" } ], "type": "list" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { @@ -19751,13 +19798,42 @@ "name": "ipaddressid", "type": "string" }, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, { "description": "the network id of the firewall rule", "name": "networkid", "type": "string" }, {}, - {} + { + "description": "the 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": "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": "the state of the rule", + "name": "state", + "type": "string" + } ] }, { @@ -19766,18 +19842,12 @@ "name": "cleanVMReservations", "params": [], "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", @@ -19787,6 +19857,12 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -19806,27 +19882,27 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "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" - } + {} ] }, { @@ -19834,6 +19910,20 @@ "isasync": true, "name": "extractIso", "params": [ + { + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, + "type": "string" + }, + { + "description": "the URL to which the ISO would be extracted", + "length": 2048, + "name": "url", + "required": false, + "type": "string" + }, { "description": "the ID of the ISO file", "length": 255, @@ -19849,89 +19939,74 @@ "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" - }, - { - "description": "the URL to which the ISO would be extracted", - "length": 2048, - "name": "url", - "required": false, - "type": "string" - }, - { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", - "length": 255, - "name": "mode", - "required": true, - "type": "string" } ], "related": "downloadImageStoreObject,extractTemplate,extractVolume", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "the status of the extraction", + "name": "status", + "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" }, { "description": "the id of extracted object", "name": "id", "type": "string" }, - {}, - {}, { - "description": "the status of the extraction", - "name": "status", - "type": "string" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "", - "name": "resultstring", + "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", + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", "type": "integer" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, + {}, { - "description": "type of the storage", - "name": "storagetype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -19940,15 +20015,16 @@ "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "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" - } + }, + {} ] }, { @@ -19957,62 +20033,51 @@ "name": "listObjectStoragePools", "params": [ { - "description": "", + "description": "the ID of the storage pool", "length": 255, - "name": "pagesize", + "name": "id", + "related": "addObjectStoragePool,listObjectStoragePools", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "the name of the object store", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "the object store provider", "length": 255, - "name": "keyword", + "name": "provider", "required": false, "type": "string" }, { - "description": "the ID of the storage pool", + "description": "", "length": 255, - "name": "id", - "related": "addObjectStoragePool,listObjectStoragePools", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the object store", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the object store provider", + "description": "List by keyword", "length": 255, - "name": "provider", + "name": "keyword", "required": false, "type": "string" } ], "related": "addObjectStoragePool", "response": [ - {}, - { - "description": "the ID of the object store", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the url of the object store", "name": "url", @@ -20029,26 +20094,37 @@ "name": "providername", "type": "string" }, + { + "description": "the object store currently used size", + "name": "storageused", + "type": "long" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the object store currently used size", - "name": "storageused", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total size of the object store", - "name": "storagetotal", - "type": "long" + "description": "the ID of the object store", + "name": "id", + "type": "string" }, { "description": "the name of the object store", "name": "name", "type": "string" - } + }, + { + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" + }, + {} ], "since": "4.19.0" }, @@ -20058,11 +20134,12 @@ "name": "createSecondaryStagingStore", "params": [ { - "description": "the details for the staging store", + "description": "the Zone ID for the staging store", "length": 255, - "name": "details", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "map" + "type": "uuid" }, { "description": "the staging store provider name", @@ -20072,19 +20149,18 @@ "type": "string" }, { - "description": "the Zone ID for the staging store", + "description": "the scope of the staging store: zone only for now", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "scope", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the scope of the staging store: zone only for now", + "description": "the details for the staging store", "length": 255, - "name": "scope", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { "description": "the URL for the staging store", @@ -20101,27 +20177,15 @@ "name": "name", "type": "string" }, - {}, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - { - "description": "the url of the image store", - "name": "url", - "type": "string" - }, - {}, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { "description": "the Zone name of the image store", @@ -20129,19 +20193,35 @@ "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -20154,19 +20234,15 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, + {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "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" } ] }, @@ -20175,14 +20251,6 @@ "isasync": true, "name": "createAffinityGroup", "params": [ - { - "description": "domainId of the account owning the affinity group", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, { "description": "create affinity group for project", "length": 255, @@ -20199,12 +20267,20 @@ "type": "string" }, { - "description": "an account for the affinity group. Must be used with domainId.", + "description": "Type of the affinity group from the available affinity/anti-affinity group types", "length": 255, - "name": "account", - "required": false, + "name": "type", + "required": true, "type": "string" }, + { + "description": "domainId of the account owning the affinity group", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, { "description": "optional description of the affinity group", "length": 255, @@ -20213,55 +20289,53 @@ "type": "string" }, { - "description": "Type of the affinity group from the available affinity/anti-affinity group types", + "description": "an account for the affinity group. Must be used with domainId.", "length": 255, - "name": "type", - "required": true, + "name": "account", + "required": false, "type": "string" } ], "related": "", "response": [ { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, - {}, { - "description": "the name of the affinity group", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the affinity group", + "name": "project", + "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { @@ -20274,15 +20348,17 @@ "name": "domain", "type": "string" }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the account owning the affinity group", "name": "account", "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" } ] }, @@ -20301,23 +20377,23 @@ } ], "response": [ - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "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", @@ -20331,18 +20407,18 @@ "name": "oauthlogin", "params": [ { - "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", + "description": "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": "domainId", + "name": "domain", "required": false, - "type": "long" + "type": "string" }, { - "description": "Name of the provider", + "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": "provider", - "required": true, - "type": "string" + "name": "domainId", + "required": false, + "type": "long" }, { "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", @@ -20352,16 +20428,16 @@ "type": "string" }, { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "description": "Email id with which user tried to login using OAuth provider", "length": 255, - "name": "domain", - "required": false, + "name": "email", + "required": true, "type": "string" }, { - "description": "Email id with which user tried to login using OAuth provider", + "description": "Name of the provider", "length": 255, - "name": "email", + "name": "provider", "required": true, "type": "string" } @@ -20369,24 +20445,9 @@ "related": "login", "response": [ { - "description": "Username", - "name": "username", - "type": "string" - }, - { - "description": "user time zone", - "name": "timezone", - "type": "string" - }, - { - "description": "the account name the user belongs to", - "name": "account", - "type": "string" - }, - { - "description": "Two factor authentication provider", - "name": "providerfor2fa", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "User ID", @@ -20394,35 +20455,41 @@ "type": "string" }, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, + { + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "Username", + "name": "username", "type": "string" }, - {}, { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" + "description": "user time zoneoffset", + "name": "timezoneoffset", + "type": "string" }, + {}, { - "description": "first name of the user", - "name": "firstname", + "description": "the account name the user belongs to", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", + "type": "string" }, { "description": "last name of the user", @@ -20434,15 +20501,14 @@ "name": "type", "type": "string" }, - {}, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "user time zone", + "name": "timezone", "type": "string" }, { - "description": "Is two factor authentication verified", - "name": "is2faverified", + "description": "Is user registered", + "name": "registered", "type": "string" }, { @@ -20456,8 +20522,18 @@ "type": "string" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "Is two factor authentication verified", + "name": "is2faverified", + "type": "string" + }, + { + "description": "Two factor authentication provider", + "name": "providerfor2fa", + "type": "string" + }, + { + "description": "first name of the user", + "name": "firstname", "type": "string" } ], @@ -20468,6 +20544,13 @@ "isasync": false, "name": "listInternalLoadBalancerElements", "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "List by keyword", "length": 255, @@ -20475,6 +20558,14 @@ "required": false, "type": "string" }, + { + "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": "list internal load balancer elements by id", "length": 255, @@ -20496,30 +20587,21 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "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,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", - "required": false, - "type": "uuid" } ], "related": "createInternalLoadBalancerElement,configureInternalLoadBalancerElement", "response": [ + {}, { "description": "Enabled/Disabled the element", "name": "enabled", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the physical network service provider id of the element", "name": "nspid", @@ -20531,12 +20613,6 @@ "type": "string" }, {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -20550,6 +20626,14 @@ "isasync": true, "name": "updateLBHealthCheckPolicy", "params": [ + { + "description": "ID of load balancer health check policy", + "length": 255, + "name": "id", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies,updateLBHealthCheckPolicy", + "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, @@ -20565,30 +20649,33 @@ "required": false, "since": "4.4", "type": "boolean" - }, - { - "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 domain of the HealthCheck policy", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ { - "description": "the LB HealthCheck policy ID", - "name": "id", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", "type": "int" }, { @@ -20597,23 +20684,18 @@ "type": "int" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" - }, - { - "description": "the description of the healthcheck policy", - "name": "description", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the LB HealthCheck policy ID", + "name": "id", "type": "string" }, { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", + "description": "the description of the healthcheck policy", + "name": "description", "type": "string" }, { @@ -20625,30 +20707,24 @@ "description": "is policy for display to the regular user", "name": "fordisplay", "type": "boolean" + }, + { + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" } ], "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 the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" - }, { - "description": "the LB rule ID", - "name": "lbruleid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the account of the HealthCheck policy", @@ -20656,13 +20732,13 @@ "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": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {} @@ -20674,6 +20750,13 @@ "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, @@ -20687,56 +20770,49 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "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" } ], "related": "", "response": [ {}, - { - "description": "the hypervisor", - "name": "hypervisor", - "type": "string" - }, - { - "description": "version of the hypervisor for guest os names", - "name": "hypervisorversion", - "type": "string" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the guest OS count of the hypervisor", + "name": "guestoscount", + "type": "integer" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the guest OS count of the hypervisor", - "name": "guestoscount", - "type": "integer" + "description": "the hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "version of the hypervisor for guest os names", + "name": "hypervisorversion", + "type": "string" }, { "description": "the guest OS list of the hypervisor", "name": "guestoslist", "response": [ { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" } ], @@ -20750,13 +20826,6 @@ "isasync": true, "name": "removeTungstenFabricPolicyRule", "params": [ - { - "description": "the Uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -20765,6 +20834,13 @@ "required": true, "type": "uuid" }, + { + "description": "the Uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" + }, { "description": "the Uuid of Tungsten-Fabric policy rule", "length": 255, @@ -20776,32 +20852,32 @@ "related": "listTungstenFabricPolicy,applyTungstenFabricPolicy,removeTungstenFabricPolicy", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, - {}, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { "description": "list Tungsten-Fabric policy network name", @@ -20809,9 +20885,9 @@ "type": "list" }, { - "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" } ] }, @@ -20821,17 +20897,17 @@ "name": "createTungstenFabricProvider", "params": [ { - "description": "Tungsten-Fabric provider introspect port", + "description": "Tungsten-Fabric provider hostname", "length": 255, - "name": "tungstenproviderintrospectport", - "required": false, + "name": "tungstenproviderhostname", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric provider port", + "description": "Tungsten-Fabric provider gateway", "length": 255, - "name": "tungstenproviderport", - "required": false, + "name": "tungstengateway", + "required": true, "type": "string" }, { @@ -20843,17 +20919,17 @@ "type": "uuid" }, { - "description": "Tungsten-Fabric provider hostname", + "description": "Tungsten-Fabric provider vrouter port", "length": 255, - "name": "tungstenproviderhostname", - "required": true, + "name": "tungstenprovidervrouterport", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric provider gateway", + "description": "Tungsten-Fabric provider port", "length": 255, - "name": "tungstengateway", - "required": true, + "name": "tungstenproviderport", + "required": false, "type": "string" }, { @@ -20864,9 +20940,9 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider vrouter port", + "description": "Tungsten-Fabric provider introspect port", "length": 255, - "name": "tungstenprovidervrouterport", + "name": "tungstenproviderintrospectport", "required": false, "type": "string" } @@ -20874,39 +20950,29 @@ "related": "listTungstenFabricProviders", "response": [ { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "Tungsten-Fabric provider name", - "name": "name", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", "type": "string" }, + {}, { "description": "true if security groups support is enabled, false otherwise", "name": "securitygroupsenabled", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", + "type": "string" }, { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", "type": "string" }, { @@ -20914,26 +20980,36 @@ "name": "tungstenprovidervrouterport", "type": "string" }, - {}, { "description": "Tungsten-Fabric provider hostname", "name": "tungstenproviderhostname", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider name", + "name": "name", "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -20942,14 +21018,6 @@ "isasync": true, "name": "rebootVirtualMachine", "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, { "description": "Force reboot the VM (VM is Stopped and then Started)", "length": 255, @@ -20965,40 +21033,28 @@ "required": false, "since": "4.15.0.0", "type": "boolean" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" } ], "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, { "description": "the outgoing network traffic on the host in KiB", "name": "networkkbswrite", @@ -21010,27 +21066,27 @@ "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, { "description": "the ID of the affinity group", "name": "id", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { @@ -21039,8 +21095,8 @@ "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { @@ -21048,6 +21104,16 @@ "name": "project", "type": "string" }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, { "description": "the project ID of the affinity group", "name": "projectid", @@ -21062,63 +21128,77 @@ "description": "the description of the affinity group", "name": "description", "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" } ], "type": "set" }, - {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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 ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "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 virtual machine", + "name": "name", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -21126,11 +21206,6 @@ "name": "domain", "type": "string" }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "tag key name", "name": "key", @@ -21146,6 +21221,16 @@ "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", @@ -21160,459 +21245,334 @@ "description": "the project name where tag belongs to", "name": "project", "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" } ], "type": "set" }, + {}, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, { "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the 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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + {}, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "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": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" + "description": "the ip address of the nic", + "name": "ipaddress", + "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 ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ { "description": "MTU configured on the NIC", "name": "mtu", "type": "integer" }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, { "description": "public IP address associated with this nic via Static nat rule", "name": "publicip", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "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 ID of the nic", - "name": "id", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -21621,64 +21581,49 @@ "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, - { - "description": "the 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", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" } ], "type": "set" @@ -21688,196 +21633,60 @@ "name": "passwordenabled", "type": "boolean" }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - {}, - { - "description": "the state of the virtual machine", - "name": "state", - "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", - "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": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the project id of the vm", - "name": "projectid", + "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 group name of the virtual machine", "name": "group", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { @@ -21886,48 +21695,360 @@ "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the 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 domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the 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 name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the 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 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": "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "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 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" + } + ], + "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" + } + ], + "type": "set" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -21936,69 +22057,24 @@ "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "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": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" } ] }, @@ -22017,18 +22093,6 @@ } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -22038,6 +22102,18 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.11" @@ -22073,12 +22149,11 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -22090,10 +22165,11 @@ "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.19.0" }, @@ -22103,26 +22179,27 @@ "name": "createLoadBalancerRule", "params": [ { - "description": "the public port from where the network traffic will be load balanced from", + "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", "length": 255, - "name": "publicport", - "required": true, - "type": "integer" + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed.", + "description": "name of the load balancer rule", "length": 255, - "name": "cidrlist", - "required": false, - "since": "4.18.0.0", - "type": "list" + "name": "name", + "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. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", + "description": "public IP address ID from where the network traffic will be load balanced from", "length": 255, - "name": "openfirewall", + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the description of the load balancer rule", @@ -22132,12 +22209,18 @@ "type": "string" }, { - "description": "the domain ID associated with the load balancer", + "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "privateport", + "required": true, + "type": "integer" + }, + { + "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", @@ -22147,6 +22230,13 @@ "required": false, "type": "uuid" }, + { + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB 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 protocol for the LB such as tcp, udp or tcp-proxy.", "length": 255, @@ -22155,33 +22245,34 @@ "type": "string" }, { - "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "account", - "required": false, + "name": "algorithm", + "required": true, "type": "string" }, { - "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", + "description": "the 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": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "cidrlist", "required": false, - "type": "uuid" + "since": "4.18.0.0", + "type": "list" }, { - "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", + "description": "the domain ID associated with the load balancer", "length": 255, - "name": "privateport", - "required": true, - "type": "integer" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "the public port from where the network traffic will be load balanced from", "length": 255, - "name": "algorithm", + "name": "publicport", "required": true, - "type": "string" + "type": "integer" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -22190,28 +22281,18 @@ "required": false, "since": "4.4", "type": "boolean" - }, - { - "description": "public IP address ID from where the network traffic will be load balanced from", - "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" - }, - { - "description": "name of the load balancer rule", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], "related": "listLoadBalancerRules,updateLoadBalancerRule", "response": [ { - "description": "the account of the load balancer rule", - "name": "account", + "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" }, { @@ -22219,165 +22300,160 @@ "name": "zoneid", "type": "string" }, + {}, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, { "description": "the state of the rule", "name": "state", "type": "string" }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, + {}, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the domain of the load balancer rule", "name": "domain", "type": "string" }, + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, { "description": "the list of resource tags associated with load balancer", "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - {}, { "description": "the private port", "name": "privateport", "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 name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, { "description": "the id of the guest network the lb rule belongs to", "name": "networkid", "type": "string" }, { - "description": "the 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 protocol of the loadbalanacer rule", - "name": "protocol", + "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 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" - }, - {} + } ] }, { @@ -22392,13 +22468,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the ID of zone", "length": 255, @@ -22408,18 +22477,18 @@ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric network", + "description": "List by keyword", "length": 255, - "name": "networkuuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -22427,19 +22496,25 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric network", + "length": 255, + "name": "networkuuid", + "required": false, + "type": "string" } ], "related": "createTungstenFabricLogicalRouter,addTungstenFabricNetworkGatewayToLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", "response": [ { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "type": "string" }, { @@ -22447,26 +22522,27 @@ "name": "network", "type": "list" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric logical router name", + "name": "name", + "type": "string" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric logical router name", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -22487,8 +22563,13 @@ "related": "listVsphereStoragePolicies", "response": [ { - "description": "the ID of the Storage Policy", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "type": "string" }, { @@ -22496,31 +22577,26 @@ "name": "name", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the description of the Storage Policy", - "name": "description", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" }, { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", + "description": "the description of the Storage Policy", + "name": "description", "type": "string" }, {}, - {}, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -22531,10 +22607,10 @@ "name": "addGuestOsMapping", "params": [ { - "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", + "description": "Hypervisor type. One of : XenServer, KVM, VMWare", "length": 255, - "name": "osdisplayname", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { @@ -22546,20 +22622,27 @@ "type": "uuid" }, { - "description": "Hypervisor type. One of : XenServer, KVM, VMWare", + "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", "length": 255, - "name": "hypervisor", - "required": true, + "name": "osdisplayname", + "required": false, "type": "string" }, { - "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", + "description": "Forces add user defined guest os mapping, overrides any existing user defined mapping", "length": 255, - "name": "osmappingcheckenabled", + "name": "forced", "required": false, "since": "4.19.0", "type": "boolean" }, + { + "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", + "length": 255, + "name": "hypervisorversion", + "required": true, + "type": "string" + }, { "description": "OS name specific to the hypervisor", "length": 255, @@ -22568,68 +22651,61 @@ "type": "string" }, { - "description": "Forces add user defined guest os mapping, overrides any existing user defined mapping", + "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": "forced", + "name": "osmappingcheckenabled", "required": false, "since": "4.19.0", "type": "boolean" - }, - { - "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", - "length": 255, - "name": "hypervisorversion", - "required": true, - "type": "string" } ], "related": "updateGuestOsMapping", "response": [ - {}, - { - "description": "is the mapping user defined", - "name": "isuserdefined", - "type": "string" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "the hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "standard display name for the Guest OS", "name": "osdisplayname", "type": "string" }, + {}, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "the ID of the Guest OS mapping", + "name": "id", "type": "string" } ], @@ -22652,13 +22728,24 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" + }, + { + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { @@ -22667,19 +22754,15 @@ "type": "boolean" }, { - "description": "the out-of-band management interface address", - "name": "address", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "true if out-of-band management is enabled for the host", @@ -22687,36 +22770,29 @@ "type": "boolean" }, { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" - }, - {}, - { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, - {}, { "description": "the ID of the host", "name": "hostid", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" } ], "since": "4.9.0" @@ -22727,20 +22803,11 @@ "name": "listVnfTemplates", "params": [ { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", - "length": 255, - "name": "details", - "required": false, - "since": "4.15", - "type": "list" - }, - { - "description": "the type of the template", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "templatetype", + "name": "listall", "required": false, - "since": "4.19.0", - "type": "string" + "type": "boolean" }, { "description": "list templates by zoneId", @@ -22751,12 +22818,20 @@ "type": "uuid" }, { - "description": "the template ID", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", "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": "isvnf", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "boolean" + }, + { + "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": "list resources by account. Must be used with the domainId parameter.", @@ -22766,34 +22841,33 @@ "type": "string" }, { - "description": "flag to display the resource image for the templates", + "description": "List by keyword", "length": 255, - "name": "showicon", + "name": "keyword", "required": false, - "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": "list datadisk templates by parent template id", + "description": "the hypervisor for which to restrict the search", "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": "hypervisor", "required": false, - "since": "4.4", - "type": "uuid" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the template ID", "length": 255, - "name": "tags", + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "map" + "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).", @@ -22803,27 +22877,19 @@ "type": "string" }, { - "description": "the hypervisor for which to restrict the search", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" - }, - { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "description": "show removed templates as well", "length": 255, - "name": "isvnf", + "name": "showremoved", "required": false, - "since": "4.19.0", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "showunique", "required": false, - "type": "uuid" + "since": "4.13.2", + "type": "boolean" }, { "description": "the template name", @@ -22833,19 +22899,11 @@ "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "the IDs of the templates, mutually exclusive with id", @@ -22857,38 +22915,56 @@ "type": "list" }, { - "description": "If set to true, list only unique templates across zones", + "description": "list datadisk templates by parent template id", "length": 255, - "name": "showunique", + "name": "parenttemplateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "since": "4.13.2", - "type": "boolean" + "since": "4.4", + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "flag to display the resource image for the templates", "length": 255, - "name": "listall", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isrecursive", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "show removed templates as well", + "description": "the type of the template", "length": 255, - "name": "showremoved", + "name": "templatetype", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -22896,23 +22972,13 @@ "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the template ID", + "name": "id", "type": "string" }, { @@ -22921,112 +22987,107 @@ "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "the status of the template", - "name": "status", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, + {}, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, - {}, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "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": "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": "id of the resource", - "name": "resourceid", + "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": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, { "description": "the project id of the template", "name": "projectid", "type": "string" }, { - "description": "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 domain to which the template belongs", - "name": "domain", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { "description": "true if the reset password feature is enabled, false otherwise", @@ -23034,29 +23095,19 @@ "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, { "description": "the processor bit size", "name": "bits", "type": "int" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { "description": "the type of the template", @@ -23064,33 +23115,43 @@ "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": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { @@ -23099,124 +23160,139 @@ "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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 tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { "description": "the name of the OS type for this template.", "name": "ostypename", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "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": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" } ], @@ -23227,29 +23303,6 @@ "isasync": true, "name": "deployVnfAppliance", "params": [ - { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", - "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup,updateSecurityGroup", - "required": false, - "type": "list" - }, - { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", - "length": 255, - "name": "networkids", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "list" - }, - { - "description": "true if start vm after creating; defaulted to true if not specified", - "length": 255, - "name": "startvm", - "required": false, - "type": "boolean" - }, { "description": "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, @@ -23260,70 +23313,63 @@ "type": "uuid" }, { - "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", - "length": 255, - "name": "iptonetworklist", - "required": false, - "type": "map" - }, - { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "dynamicscalingenabled", + "name": "customid", "required": false, - "since": "4.16", - "type": "boolean" + "type": "string" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "description": "the ID of the Userdata", "length": 255, - "name": "password", + "name": "userdataid", + "related": "", "required": false, - "since": "4.19.0.0", - "type": "string" + "since": "4.18", + "type": "uuid" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "keypair", + "name": "bootintosetup", "required": false, - "type": "string" + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "bootmode", + "name": "account", "required": false, - "since": "4.14.0.0", "type": "string" }, { - "description": "The number of queues for multiqueue NICs.", + "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", "length": 255, - "name": "nicmultiqueuenumber", + "name": "datadiskofferinglist", "required": false, - "since": "4.18", - "type": "integer" + "since": "4.11", + "type": "map" }, { - "description": "the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0.", + "description": "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": "vnfcidrlist", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "description": "Controls specific policies on IO", "length": 255, - "name": "copyimagetags", + "name": "iodriverpolicy", "required": false, - "since": "4.13", - "type": "boolean" + "type": "string" }, { - "description": "True by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. False otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "vnfconfiguremanagement", + "name": "startvm", "required": false, "type": "boolean" }, @@ -23336,66 +23382,76 @@ "type": "map" }, { - "description": "the mac address for default vm's network", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "macaddress", + "name": "password", "required": false, + "since": "4.19.0.0", "type": "string" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "deploymentplanner", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "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": "userdatadetails", + "name": "bootmode", "required": false, - "since": "4.18", - "type": "map" + "since": "4.14.0.0", + "type": "string" }, { - "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "description": "the mac address for default vm's network", "length": 255, - "name": "datadiskofferinglist", + "name": "macaddress", "required": false, - "since": "4.11", - "type": "map" + "type": "string" }, { - "description": "host name for the virtual machine", + "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": "name", + "name": "boottype", "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the ipv6 address for default vm's network", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "ip6address", + "name": "networkids", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "list" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, + "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": "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 ip address for default vm's network", "length": 255, @@ -23404,36 +23460,36 @@ "type": "string" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "keypairs", + "name": "dynamicscalingenabled", "required": false, - "since": "4.17", - "type": "list" + "since": "4.16", + "type": "boolean" }, { - "description": "the ID of the Userdata", + "description": "Enable packed virtqueues or not.", "length": 255, - "name": "userdataid", - "related": "", + "name": "nicpackedvirtqueuesenabled", "required": false, "since": "4.18", - "type": "uuid" + "type": "boolean" }, { - "description": "an optional group for the virtual machine", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "group", + "name": "nicmultiqueuenumber", "required": false, - "type": "string" + "since": "4.18", + "type": "integer" }, { - "description": "Deploy vm for the project", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "keypairs", "required": false, - "type": "uuid" + "since": "4.17", + "type": "list" }, { "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", @@ -23442,6 +23498,22 @@ "required": false, "type": "string" }, + { + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18", + "type": "map" + }, + { + "description": "Deploy vm for the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, { "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", "length": 5120, @@ -23451,82 +23523,79 @@ "type": "string" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", "length": 255, - "name": "affinitygroupnames", - "related": "", + "name": "securitygroupnames", + "related": "createSecurityGroup,updateSecurityGroup", "required": false, "type": "list" }, { - "description": "availability zone for the virtual machine", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "displayname", + "required": false, + "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "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": "account", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "an optional user generated name for the virtual machine", + "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", "length": 255, - "name": "displayname", + "name": "iothreadsenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "displayvm", "required": false, - "type": "uuid" + "since": "4.2", + "type": "boolean" }, { - "description": "the ID of the template for the virtual machine", + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", "length": 255, - "name": "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" + "name": "affinitygroupids", + "related": "", + "required": false, + "type": "list" }, { - "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "nicnetworklist", - "required": false, - "since": "4.15", - "type": "map" + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "deploymentplanner", + "name": "keypair", "required": false, - "since": "4.4", "type": "string" }, { - "description": "used to specify the vApp properties.", + "description": "host name for the virtual machine", "length": 255, - "name": "properties", + "name": "name", "required": false, - "since": "4.15", - "type": "map" + "type": "string" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", "length": 255, - "name": "displayvm", + "name": "rootdisksize", "required": false, - "since": "4.2", - "type": "boolean" + "since": "4.4", + "type": "long" }, { "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", @@ -23536,78 +23605,85 @@ "type": "long" }, { - "description": "Enable packed virtqueues or not.", + "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": "nicpackedvirtqueuesenabled", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, - "since": "4.18", - "type": "boolean" + "type": "uuid" }, { - "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "description": "an optional group for the virtual machine", "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup,updateSecurityGroup", + "name": "group", "required": false, - "type": "list" + "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "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": "customid", + "name": "dhcpoptionsnetworklist", "required": false, - "type": "string" + "type": "map" }, { - "description": "Controls specific policies on IO", + "description": "the ipv6 address for default vm's network", "length": 255, - "name": "iodriverpolicy", + "name": "ip6address", "required": false, "type": "string" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "description": "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": "dhcpoptionsnetworklist", + "name": "vnfcidrlist", "required": false, - "type": "map" + "type": "list" }, { - "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "description": "availability zone for the virtual machine", "length": 255, - "name": "iothreadsenabled", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "used to specify the vApp properties.", + "length": 255, + "name": "properties", "required": false, - "type": "boolean" + "since": "4.15", + "type": "map" }, { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "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": "boottype", + "name": "iptonetworklist", "required": false, - "since": "4.14.0.0", - "type": "string" + "type": "map" }, { - "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "description": "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": "rootdisksize", + "name": "nicnetworklist", "required": false, - "since": "4.4", - "type": "long" + "since": "4.15", + "type": "map" }, { - "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "description": "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": "hypervisor", + "name": "vnfconfiguremanagement", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "bootintosetup", + "name": "copyimagetags", "required": false, - "since": "4.15.0.0", + "since": "4.13", "type": "boolean" }, { @@ -23618,558 +23694,200 @@ "type": "string" }, { - "description": "the ID of the service offering for the virtual machine", + "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": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" } ], "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "ssh key-pairs", + "name": "keypairs", "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 service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, - {}, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the ID of the security group", + "description": "the ID of the affinity group", "name": "id", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", + "description": "the name of the affinity group", "name": "name", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the security group", + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the description of the security group", + "description": "the description of the affinity group", "name": "description", "type": "string" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "tag value", - "name": "value", + "description": "the type of the affinity group", + "name": "type", "type": "string" } ], "type": "set" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -24178,28 +23896,13 @@ "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "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", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -24208,23 +23911,18 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -24233,13 +23931,13 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -24247,31 +23945,11 @@ "name": "extradhcpoption", "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": "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, { "description": "the gateway of the nic", "name": "gateway", @@ -24283,214 +23961,159 @@ "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 isolation uri of the nic", - "name": "isolationuri", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { "description": "true if nic is default, false otherwise", "name": "isdefault", "type": "boolean" - } - ], - "type": "set" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "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": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, + {}, { "description": "the number of vCPUs this virtual machine is using", "name": "cpunumber", "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, + {}, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "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 virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the 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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { "description": "the date when this virtual machine was updated last time", @@ -24498,140 +24121,231 @@ "type": "date" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "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": "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": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "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 user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the 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": "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, - {}, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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 userdata used for the VM", "name": "userdataname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "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 group name of the virtual machine", - "name": "group", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -24640,24 +24354,386 @@ "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "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 control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the 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" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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": "security group name", + "name": "securitygroupname", + "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 account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" + }, + { + "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": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" } ], "since": "4.19.0" @@ -24668,19 +24744,26 @@ "name": "updateNetworkOffering", "params": [ { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 4096, - "name": "zoneid", + "description": "the name of the network offering", + "length": 255, + "name": "name", "required": false, - "since": "4.13", "type": "string" }, { - "description": "update state for the network offering", + "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", "length": 255, - "name": "state", + "name": "keepaliveenabled", "required": false, - "type": "string" + "type": "boolean" + }, + { + "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", @@ -24690,18 +24773,18 @@ "type": "string" }, { - "description": "sort key of the network offering, integer", + "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": "sortkey", + "name": "availability", "required": false, - "type": "integer" + "type": "string" }, { - "description": "maximum number of concurrent connections supported by the network offering", + "description": "update state for the network offering", "length": 255, - "name": "maxconnections", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { "description": "the tags for the network offering.", @@ -24711,33 +24794,26 @@ "type": "string" }, { - "description": "the availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required ", - "length": 255, - "name": "availability", - "required": false, - "type": "string" - }, - { - "description": "the id of the network offering", + "description": "sort key of the network offering, integer", "length": 255, - "name": "id", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "sortkey", "required": false, - "type": "uuid" + "type": "integer" }, { - "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", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 4096, + "name": "zoneid", "required": false, - "type": "boolean" + "since": "4.13", + "type": "string" }, { - "description": "the name of the network offering", + "description": "maximum number of concurrent connections supported by the network offering", "length": 255, - "name": "name", + "name": "maxconnections", "required": false, - "type": "string" + "type": "integer" }, { "description": "the display text of the network offering", @@ -24750,28 +24826,39 @@ "related": "createNetworkOffering,listNetworkOfferings", "response": [ { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "type": "boolean" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", "type": "integer" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "true if network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", "type": "boolean" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -24779,87 +24866,133 @@ "name": "zone", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, { "description": "true if network offering supports persistent networks, false otherwise", "name": "ispersistent", "type": "boolean" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", + "type": "string" }, - {}, { - "description": "the tags for the network offering", - "name": "tags", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, - {}, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" + "description": "the internet protocol of the network offering", + "name": "internetprotocol", + "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": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", "type": "boolean" }, + { + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" + }, + {}, { "description": "the name of the network offering", "name": "name", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "description": "the id of the network offering", + "name": "id", + "type": "string" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", "type": "boolean" }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the 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", @@ -24870,339 +25003,205 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "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", + "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": "services for this provider", "name": "servicelist", "type": "list" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" }, { - "description": "the capability value", - "name": "value", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the date this network offering was created", + "name": "created", + "type": "date" + }, + { + "description": "availability of the network offering", + "name": "availability", "type": "string" + } + ] + }, + { + "description": "Stops a system VM.", + "isasync": true, + "name": "stopSystemVm", + "params": [ + { + "description": "The ID of the system virtual machine", + "length": 255, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", + "required": true, + "type": "uuid" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, "type": "boolean" - }, + } + ], + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "response": [ { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the id of the network offering", + "description": "the ID of the system VM", "name": "id", "type": "string" }, + {}, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - } - ] - }, - { - "description": "Lists all IPv6 firewall rules", - "isasync": false, - "name": "listIpv6FirewallRules", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "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": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the name of the system VM", + "name": "name", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the private IP address for the system VM", + "name": "privateip", + "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 template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "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" + "description": "the Pod ID for the system VM", + "name": "podid", + "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 number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "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": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, { - "description": "Lists ipv6 firewall rule with the specified ID", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": false, - "type": "uuid" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "guest vlan range", + "name": "guestvlan", "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": "list ipv6 firewall rules by traffic type - ingress or egress", - "length": 255, - "name": "traffictype", - "required": false, + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" - } - ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "response": [ + }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, - {}, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "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 project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { @@ -25211,90 +25210,19 @@ "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - } - ] - }, - { - "description": "Stops a system VM.", - "isasync": true, - "name": "stopSystemVm", - "params": [ - { - "description": "The ID of the system virtual machine", - "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", - "required": true, - "type": "uuid" - }, - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - } - ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "response": [ - { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the network domain for the system VM", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" - }, - { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { "description": "the private MAC address for the system VM", @@ -25302,33 +25230,24 @@ "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" - }, - { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, + {}, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { @@ -25336,71 +25255,14 @@ "name": "hasannotations", "type": "boolean" }, - { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" - }, - { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" - }, - {}, - { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" - }, - { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" - }, - { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" - }, - { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" - }, - { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" - }, - {}, { "description": "the date and time the system VM was created", "name": "created", "type": "date" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { @@ -25409,69 +25271,29 @@ "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" - }, - { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" - }, - { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the ID of the system VM", - "name": "id", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "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" } ] }, @@ -25484,34 +25306,34 @@ "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "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": "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" - } + {} ] }, { @@ -25519,22 +25341,6 @@ "isasync": true, "name": "updateVPC", "params": [ - { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC", - "length": 255, - "name": "sourcenatipaddress", - "required": false, - "since": "4.19", - "type": "string" - }, - { - "description": "an optional field, whether to the display the vpc to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "the id of the VPC", "length": 255, @@ -25552,13 +25358,20 @@ "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 display text of the VPC", "length": 255, - "name": "customid", + "name": "displaytext", "required": false, - "since": "4.4", "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", + "type": "boolean" + }, { "description": "the name of the VPC", "length": 255, @@ -25567,82 +25380,82 @@ "type": "string" }, { - "description": "the display text of the VPC", + "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": "displaytext", + "name": "sourcenatipaddress", + "required": false, + "since": "4.19", + "type": "string" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", "required": false, + "since": "4.4", "type": "string" } ], "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ + {}, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, - { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - }, { "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the 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": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -25653,111 +25466,24 @@ ], "type": "list" }, - {}, - { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" - }, - { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" - }, - { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, - { - "description": "the id of the VPC", - "name": "id", - "type": "string" - }, - { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "the name of the VPC", - "name": "name", - "type": "string" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" - }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", @@ -25768,6 +25494,11 @@ "name": "id", "type": "string" }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", @@ -25778,36 +25509,21 @@ "name": "destinationphysicalnetworkid", "type": "string" }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "state of the network provider", "name": "state", "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" } ], "type": "list" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the list of capabilities", "name": "capability", "response": [ { - "description": "the capability name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" }, { @@ -25816,8 +25532,8 @@ "type": "boolean" }, { - "description": "the capability value", - "name": "value", + "description": "the capability name", + "name": "name", "type": "string" } ], @@ -25827,39 +25543,69 @@ "type": "list" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "if this VPC has redundant router", @@ -25867,269 +25613,221 @@ "type": "boolean" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - } - ] - }, - { - "description": "Changes out-of-band management interface password on the host and updates the interface configuration in CloudStack if the operation succeeds, else reverts the old password", - "isasync": true, - "name": "changeOutOfBandManagementPassword", - "params": [ + }, { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "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, + "description": "the owner of the VPC", + "name": "account", "type": "string" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction", - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" }, - {}, - {}, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" } - ], - "since": "4.9.0" + ] }, { - "description": "List VM Schedules.", - "isasync": false, - "name": "listVMSchedule", + "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": "ID of VM schedule", + "description": "the ID of the host", "length": 255, - "name": "id", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", - "required": false, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "required": true, "type": "uuid" }, { - "description": "Action taken by schedule", + "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", "length": 255, - "name": "action", + "name": "password", "required": false, "type": "string" - }, + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction", + "response": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the operation result description", + "name": "description", "type": "string" }, { - "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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "ID of VM schedule", - "length": 255, - "name": "enabled", - "required": false, + "description": "the operation result", + "name": "status", "type": "boolean" - } - ], - "related": "createVMSchedule,updateVMSchedule", - "response": [ - { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" }, { - "description": "Description of VM schedule", - "name": "description", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "Action", - "name": "action", - "type": "action" - }, - { - "description": "the ID of VM schedule", - "name": "id", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, {}, { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, - {}, { - "description": "Timezone of the schedule", - "name": "timezone", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "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 out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, + {}, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" - }, - { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" } ], - "since": "4.19.0" + "since": "4.9.0" }, { - "description": "List resource detail(s)", + "description": "Lists all IPv6 firewall rules", "isasync": false, - "name": "listResourceDetails", + "name": "listIpv6FirewallRules", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list by key", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "key", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list by key, value. Needs to be passed only along with key", + "description": "list ipv6 firewall rules by network ID", "length": 255, - "name": "value", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { "description": "list only resources belonging to the domain specified", @@ -26140,19 +25838,26 @@ "type": "uuid" }, { - "description": "if set to true, only details marked with display=true, are returned. False by default", + "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 display flag; only ROOT admin is eligible to pass this parameter", "length": 255, "name": "fordisplay", "required": false, - "since": "4.3", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "account", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { "description": "", @@ -26162,375 +25867,549 @@ "type": "integer" }, { - "description": "list by resource id", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "resourceid", + "name": "account", "required": false, "type": "string" }, { - "description": "list by resource type", - "length": 255, - "name": "resourcetype", - "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": "Lists ipv6 firewall rule with the specified ID", "length": 255, - "name": "listall", + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list ipv6 firewall rules by traffic type - ingress or egress", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "traffictype", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "listTags", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, + {}, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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 domain associated with the tag", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "tag value", - "name": "value", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" - } - ], - "since": "4.2" - }, - { - "description": "Attempts to live patch systemVMs - CPVM, SSVM ", - "isasync": true, - "name": "patchSystemVm", - "params": [ - { - "description": "patches systemVM - CPVM/SSVM with the specified ID", - "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": false, - "type": "uuid" }, { - "description": "If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only", - "length": 255, - "name": "forced", - "required": false, + "description": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" - } - ], - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, {}, - {}, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, { "description": "the 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": "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "list" } - ], - "since": "4.17.0" + ] }, { - "description": "Dedicate an existing cluster", - "isasync": true, - "name": "dedicateCluster", + "description": "List VM Schedules.", + "isasync": false, + "name": "listVMSchedule", "params": [ { - "description": "the ID of the Cluster", + "description": "Action taken by schedule", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, + "name": "action", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "ID of VM schedule", + "length": 255, + "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 ID of the containing domain", + "description": "ID of the VM for which schedule is to be defined", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, { - "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" } ], - "related": "listDedicatedClusters", + "related": "createVMSchedule,updateVMSchedule", "response": [ { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, - {}, - {}, { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "Action", + "name": "action", + "type": "action" + }, + { + "description": "Description of VM schedule", + "name": "description", + "type": "string" + }, + { + "description": "Cron formatted VM schedule", + "name": "schedule", "type": "string" }, + {}, + { + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of VM schedule", + "name": "id", "type": "string" }, { - "description": "the name of the cluster", - "name": "clustername", - "type": "string" + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" }, { - "description": "the domain ID of the cluster", - "name": "domainid", - "type": "string" + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" }, + {}, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "ID of virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + }, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" } - ] + ], + "since": "4.19.0" }, { - "description": "Creates a network offering.", + "description": "List resource detail(s)", "isasync": false, - "name": "createNetworkOffering", + "name": "listResourceDetails", "params": [ { - "description": "true if network offering supports vlans", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "specifyvlan", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "desired service capabilities as part of network offering", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "servicecapabilitylist", + "name": "listall", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "serviceproviderlist", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the display text of the network offering, defaults to the value of 'name'.", + "description": "list by resource type", "length": 255, - "name": "displaytext", + "name": "resourcetype", + "required": true, + "type": "string" + }, + { + "description": "list by key, value. Needs to be passed only along with key", + "length": 255, + "name": "value", "required": false, + "since": "4.4", "type": "string" }, { - "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "fortungsten", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "the availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks ", + "description": "", "length": 255, - "name": "availability", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if the network offering is IP conserve mode enabled", + "description": "List by keyword", "length": 255, - "name": "conservemode", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if network offering is meant to be used for VPC, false otherwise.", + "description": "list by key", "length": 255, - "name": "forvpc", + "name": "key", "required": false, - "type": "boolean" + "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", + "description": "if set to true, only details marked with display=true, are returned. False by default", "length": 255, - "name": "internetprotocol", + "name": "fordisplay", "required": false, - "since": "4.17.0", - "type": "string" + "since": "4.3", + "type": "boolean" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.13", - "type": "list" + "type": "uuid" }, { - "description": "the name of the network offering", + "description": "list by resource id", "length": 255, - "name": "name", - "required": true, + "name": "resourceid", + "required": false, "type": "string" }, { - "description": "data transfer rate in megabits per second allowed", + "description": "", "length": 255, - "name": "networkrate", + "name": "page", "required": false, "type": "integer" + } + ], + "related": "listTags", + "response": [ + {}, + { + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", - "length": 255, - "name": "details", - "required": false, - "since": "4.2.0", - "type": "map" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, + {}, { - "description": "maximum number of concurrent connections supported by the network offering", - "length": 255, - "name": "maxconnections", - "required": false, + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the service offering ID used by virtual router provider", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "since": "4.2" + }, + { + "description": "Attempts to live patch systemVMs - CPVM, SSVM ", + "isasync": true, + "name": "patchSystemVm", + "params": [ + { + "description": "patches systemVM - CPVM/SSVM with the specified ID", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, "type": "uuid" }, { - "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "description": "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": "keepaliveenabled", + "name": "forced", "required": false, "type": "boolean" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "guest type of the network offering: Shared or Isolated", - "length": 255, - "name": "guestiptype", - "required": true, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.17.0" + }, + { + "description": "Creates a network offering.", + "isasync": false, + "name": "createNetworkOffering", + "params": [ + { + "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": "egressdefaultpolicy", + "name": "internetprotocol", "required": false, - "type": "boolean" + "since": "4.17.0", + "type": "string" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, + "since": "4.13", "type": "list" }, { - "description": "set to true if the offering is to be enabled during creation. Default is false", + "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": "enable", + "name": "details", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.2.0", + "type": "map" }, { "description": "the tags for the network offering.", @@ -26539,6 +26418,27 @@ "required": false, "type": "string" }, + { + "description": "true if the network offering is IP conserve mode enabled", + "length": 255, + "name": "conservemode", + "required": false, + "type": "boolean" + }, + { + "description": "true if network offering supports vlans", + "length": 255, + "name": "specifyvlan", + "required": false, + "type": "boolean" + }, + { + "description": "maximum number of concurrent connections supported by the network offering", + "length": 255, + "name": "maxconnections", + "required": false, + "type": "integer" + }, { "description": "the traffic type for the network offering. Supported type in current release is GUEST only", "length": 255, @@ -26554,101 +26454,151 @@ "type": "boolean" }, { - "description": "services supported by the network offering", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", "length": 255, - "name": "supportedservices", + "name": "egressdefaultpolicy", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", "length": 255, - "name": "ispersistent", + "name": "fortungsten", "required": false, "type": "boolean" - } - ], - "related": "listNetworkOfferings", - "response": [ + }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "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": "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": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the name of the network offering", + "length": 255, + "name": "name", + "required": true, "type": "string" }, - {}, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "services supported by the network offering", + "length": 255, + "name": "supportedservices", + "required": false, + "type": "list" }, { - "description": "additional key/value details tied with network offering", - "name": "details", + "description": "desired service capabilities as part of network offering", + "length": 255, + "name": "servicecapabilitylist", + "required": false, "type": "map" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "the service offering ID used by virtual router provider", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", + "length": 255, + "name": "serviceproviderlist", + "required": false, + "type": "map" }, { - "description": "the 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 containing domain(s), null for public offerings", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "list" }, { - "description": "the name of the network offering", - "name": "name", + "description": "the display text of the network offering, defaults to the value of 'name'.", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "guest type of the network offering: Shared or Isolated", + "length": 255, + "name": "guestiptype", + "required": true, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "length": 255, + "name": "ispersistent", + "required": false, "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed.", + "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": "data transfer rate in megabits per second allowed", + "length": 255, "name": "networkrate", + "required": false, "type": "integer" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "true if network offering is meant to be used for VPC, false otherwise.", + "length": 255, + "name": "forvpc", + "required": false, + "type": "boolean" + } + ], + "related": "listNetworkOfferings", + "response": [ + { + "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 network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "description": "the id of the network offering", + "name": "id", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "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 tags for the network offering", - "name": "tags", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { @@ -26657,14 +26607,9 @@ "type": "boolean" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "type": "boolean" - }, - { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", - "type": "string" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { "description": "the list of supported services", @@ -26675,28 +26620,28 @@ "name": "provider", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -26712,19 +26657,14 @@ ], "type": "list" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the list of capabilities", "name": "capability", "response": [ { - "description": "the capability value", - "name": "value", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { "description": "the capability name", @@ -26732,45 +26672,67 @@ "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the capability value", + "name": "value", + "type": "string" } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "availability of the network offering", + "name": "availability", + "type": "string" + }, + {}, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, + {}, { "description": "true if network offering supports persistent networks, false otherwise", "name": "ispersistent", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", + "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" + "description": "the tags for the network offering", + "name": "tags", + "type": "string" }, { - "description": "availability of the network offering", - "name": "availability", - "type": "string" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", @@ -26778,26 +26740,65 @@ "type": "string" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the id of the network offering", - "name": "id", + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" + }, + { + "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": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "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": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" + }, + { + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" + }, + { + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" + }, { "description": "true if network offering supports public access for guest networks", "name": "supportspublicaccess", @@ -26807,17 +26808,85 @@ "since": "3.0.0" }, { - "description": "Creates an IP forwarding rule", + "description": "Dedicate an existing cluster", "isasync": true, - "name": "createIpForwardingRule", + "name": "dedicateCluster", "params": [ { - "description": "the end port for the rule", + "description": "the ID of the Cluster", "length": 255, - "name": "endport", + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, + "type": "string" + } + ], + "related": "listDedicatedClusters", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the cluster", + "name": "clusterid", + "type": "string" + }, + { + "description": "the domain ID of the cluster", + "name": "domainid", + "type": "string" + }, + { + "description": "the Account ID of the cluster", + "name": "accountid", + "type": "string" + }, + {}, + { + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", + "type": "string" + }, + { + "description": "the name of the cluster", + "name": "clustername", + "type": "string" + }, + {} + ] + }, + { + "description": "Creates an IP forwarding rule", + "isasync": true, + "name": "createIpForwardingRule", + "params": [ { "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, @@ -26826,10 +26895,25 @@ "type": "boolean" }, { - "description": "the start port for the rule", + "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", "length": 255, - "name": "startport", + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "the public IP address ID of the forwarding rule, already associated via associateIp", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, + "type": "uuid" + }, + { + "description": "the end port for the rule", + "length": 255, + "name": "endport", + "required": false, "type": "integer" }, { @@ -26840,26 +26924,18 @@ "type": "string" }, { - "description": "the public IP address ID of the forwarding rule, already associated via associateIp", + "description": "the start port for the rule", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "startport", "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" + "type": "integer" } ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "response": [ { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { @@ -26867,24 +26943,61 @@ "name": "publicport", "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 private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "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", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { @@ -26893,8 +27006,8 @@ "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { @@ -26902,23 +27015,18 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag 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": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -26927,8 +27035,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -26937,73 +27045,41 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "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": "privateendport", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, { "description": "is firewall for display to the regular user", "name": "fordisplay", "type": "boolean" }, - {}, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" } ] @@ -27014,111 +27090,110 @@ "name": "listVolumesMetrics", "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 volumes on specified host", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the cluster id the disk volume belongs to", + "description": "list volumes on specified host", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, "type": "uuid" }, { - "description": "the ID of the disk volume", + "description": "the type of disk 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", + "name": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "listsystemvms", "required": false, - "type": "uuid" + "since": "4.18", + "type": "boolean" }, { - "description": "the type of disk volume", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "type", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, + "since": "4.3", "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "the ID of the disk volume", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "id", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "type": "uuid" }, { - "description": "the IDs of the volumes, mutually exclusive with id", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "ids", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "isrecursive", "required": false, - "since": "4.9", - "type": "list" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the availability zone", + "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "ids", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, - "type": "uuid" + "since": "4.9", + "type": "list" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "displayvolume", + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "the ID of the virtual machine", "length": 255, - "name": "state", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the pod id the disk volume belongs to", + "description": "the ID of the availability zone", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, @@ -27129,6 +27204,14 @@ "required": false, "type": "integer" }, + { + "description": "the cluster id the disk volume belongs to", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, { "description": "List resources by tags (key/value pairs)", "length": 255, @@ -27137,63 +27220,56 @@ "type": "map" }, { - "description": "makes the API's response contains only the resource count", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the storage pool, available to ROOT admin 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": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "listall", "required": false, - "since": "4.3", - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "list volumes by disk offering", "length": 255, - "name": "name", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, - "type": "string" + "since": "4.4", + "type": "uuid" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listsystemvms", + "name": "displayvolume", "required": false, - "since": "4.18", + "since": "4.4", "type": "boolean" }, { - "description": "List by keyword", + "description": "the name of the disk volume", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "list volumes by disk offering", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": false, - "since": "4.4", - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "account", + "name": "state", "required": false, "type": "string" } @@ -27201,43 +27277,33 @@ "related": "", "response": [ { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "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", - "type": "boolean" - }, - { - "description": "the status of the volume", - "name": "status", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { @@ -27246,79 +27312,29 @@ "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" - }, - { - "description": "disk size in GiB", - "name": "sizegb", - "type": "string" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", - "type": "long" - }, - { - "description": "pod name of the volume", - "name": "podname", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { "description": "the list of resource tags associated", @@ -27330,23 +27346,23 @@ "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 value", + "name": "value", "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -27355,138 +27371,174 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "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 ID of the 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 date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "disk size in GiB", + "name": "sizegb", "type": "string" }, + {}, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + {}, { "description": " an alternate display text of the template for the virtual machine", "name": "templatedisplaytext", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "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", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { "description": "volume uuid that is given by virtualisation provider (only for VMware)", @@ -27494,115 +27546,139 @@ "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, - {}, { - "description": "the disk utilization", - "name": "utilization", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "ID of the disk volume", + "name": "id", "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" } ], "since": "4.9.3" @@ -27628,13 +27704,8 @@ "type": "string" }, { - "description": "synchronization", - "name": "sync", - "type": "string" - }, - { - "description": "compression", - "name": "compression", + "description": "deduplication", + "name": "deduplication", "type": "string" }, { @@ -27642,20 +27713,25 @@ "name": "name", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "deduplication", - "name": "deduplication", + "description": "the id of the volume", + "name": "id", "type": "string" }, { - "description": "the id of the volume", - "name": "id", + "description": "compression", + "name": "compression", + "type": "string" + }, + {}, + { + "description": "synchronization", + "name": "sync", "type": "string" }, {}, @@ -27672,17 +27748,17 @@ "name": "listDetailOptions", "params": [ { - "description": "the UUID of the resource (optional)", + "description": "the resource type such as UserVm, Template etc.", "length": 255, - "name": "resourceid", - "required": false, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "the resource type such as UserVm, Template etc.", + "description": "the UUID of the resource (optional)", "length": 255, - "name": "resourcetype", - "required": true, + "name": "resourceid", + "required": false, "type": "string" } ], @@ -27693,18 +27769,18 @@ "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "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" - } + {} ], "since": "4.13" }, @@ -27717,15 +27793,15 @@ "description": "Load balancer rule ID", "length": 255, "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": false, "type": "uuid" }, { - "description": "Account ID", + "description": "Project that owns the SSL certificate", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -27738,10 +27814,10 @@ "type": "uuid" }, { - "description": "Project that owns the SSL certificate", + "description": "Account ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" } @@ -27749,19 +27825,13 @@ "related": "uploadSslCert", "response": [ { - "description": "name", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the project id of the certificate", - "name": "projectid", + "description": "account for the certificate", + "name": "account", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, { @@ -27769,19 +27839,40 @@ "name": "loadbalancerrulelist", "type": "list" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "certificate chain", + "name": "certchain", + "type": "string" + }, + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + {}, { "description": "certificate", "name": "certificate", "type": "string" }, { - "description": "the project name of the certificate", - "name": "project", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, { - "description": "SSL certificate ID", - "name": "id", + "description": "the project name of the certificate", + "name": "project", "type": "string" }, { @@ -27790,32 +27881,119 @@ "type": "string" }, { - "description": "certificate chain", - "name": "certchain", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "name", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "Create a quota statement", + "isasync": false, + "name": "quotaStatement", + "params": [ + { + "description": "End date range for quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "length": 255, + "name": "enddate", + "required": true, + "type": "date" + }, + { + "description": "List usage records for the specified account", + "length": 255, + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "List quota usage records for the specified usage type", + "length": 255, + "name": "type", + "required": false, + "type": "integer" + }, + { + "description": "Start date range quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.", + "length": 255, + "name": "startdate", + "required": true, + "type": "date" + }, + { + "description": "Optional, Account Id for which statement needs to be generated", + "length": 255, + "name": "account", + "required": true, "type": "string" }, { - "description": "account for the certificate", + "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": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": true, + "type": "uuid" + } + ], + "related": "quotaBalance", + "response": [ + { + "description": "account name", "name": "account", "type": "string" }, + { + "description": "quota consumed", + "name": "quota", + "type": "bigdecimal" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "domain id", + "name": "domain", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} - ] + { + "description": "account id", + "name": "accountid", + "type": "long" + }, + { + "description": "usage unit", + "name": "unit", + "type": "string" + }, + {}, + { + "description": "usage type name", + "name": "name", + "type": "string" + }, + { + "description": "usage type", + "name": "type", + "type": "int" + } + ], + "since": "4.7.0" }, { "description": "List private gateways", @@ -27823,99 +28001,99 @@ "name": "listPrivateGateways", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "list gateways by ip address", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "ipaddress", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list private gateway by id", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list gateways by state", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "list gateways by vlan", "length": 255, - "name": "keyword", + "name": "vlan", "required": false, "type": "string" }, { - "description": "list gateways by vpc", + "description": "", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list gateways by vlan", + "description": "list gateways by state", "length": 255, - "name": "vlan", + "name": "state", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list gateways by ip address", "length": 255, - "name": "account", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list private gateway by id", "length": 255, - "name": "listall", + "name": "id", + "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "", + "description": "list gateways by vpc", "length": 255, - "name": "pagesize", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", @@ -27926,69 +28104,69 @@ "type": "string" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "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", + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, { - "description": "Source Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", + "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the gateway", + "name": "gateway", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, { @@ -27997,51 +28175,51 @@ "type": "integer" }, { - "description": "the gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "the project name of the private gateway", - "name": "project", + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Source Nat enable status", + "name": "sourcenatsupported", "type": "boolean" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, + {}, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the id of the private gateway", - "name": "id", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "the id of the private gateway", + "name": "id", "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, - {} + { + "description": "zone id of the private gateway", + "name": "zoneid", + "type": "string" + } ] }, { @@ -28068,193 +28246,202 @@ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": " 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", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - {}, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the 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 amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "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": "the account associated with the tag", - "name": "account", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + } ], "type": "set" }, { - "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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "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 total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", @@ -28262,73 +28449,103 @@ "type": "boolean" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, { "description": "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 name of the virtual machine", "name": "name", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the disk 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", + "description": "Vm details in key/value pairs.", + "name": "details", "type": "map" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { @@ -28337,13 +28554,13 @@ "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { @@ -28352,178 +28569,218 @@ "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the security group", + "name": "id", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "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 id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -28532,8 +28789,8 @@ "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -28541,123 +28798,103 @@ "name": "securitygroupname", "type": "string" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 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": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the 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" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -28665,13 +28902,18 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -28685,13 +28927,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -28700,41 +28937,36 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" } ], @@ -28744,65 +28976,142 @@ "description": "the project id of the group", "name": "projectid", "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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 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" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, - {}, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "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": "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 amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "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": "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 name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { "description": "the ID of the virtual machine", @@ -28810,422 +29119,291 @@ "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + {}, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, + { + "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 ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, { "description": "the group name of the virtual machine", "name": "group", "type": "string" }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, { "description": "the control state of the host for the virtual machine", "name": "hostcontrolstate", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + } + ] + }, + { + "description": "Updates load balancer stickiness policy", + "isasync": true, + "name": "updateLBStickinessPolicy", + "params": [ + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "id of lb stickiness policy", + "length": 255, + "name": "id", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", + "required": true, + "type": "uuid" + }, + { + "description": "an optional field, whether to the display the policy to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + } + ], + "related": "createLBStickinessPolicy,listLBStickinessPolicies", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "the domain of the Stickiness policy", + "name": "domain", + "type": "string" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the account of the Stickiness policy", + "name": "account", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", "response": [ { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the state of the policy", + "name": "state", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the params of the policy", + "name": "params", + "type": "map" }, { - "description": "the type of the nic", - "name": "type", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the method name of the Stickiness policy", + "name": "methodname", "type": "string" } ], - "type": "set" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - } - ] - }, - { - "description": "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": "id of lb stickiness policy", - "length": 255, - "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", - "required": true, - "type": "uuid" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - } - ], - "related": "createLBStickinessPolicy,listLBStickinessPolicies", - "response": [ - { - "description": "the domain of the Stickiness policy", - "name": "domain", - "type": "string" - }, - { - "description": "the account of the Stickiness policy", - "name": "account", - "type": "string" + "type": "list" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the domain ID of the Stickiness policy", "name": "domainid", "type": "string" }, - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", - "response": [ - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the params of the policy", - "name": "params", - "type": "map" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the LB Stickiness policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the method name of the Stickiness policy", - "name": "methodname", - "type": "string" - } - ], - "type": "list" - }, { "description": "the id of the zone the Stickiness policy belongs to", "name": "zoneid", "type": "string" - }, - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - {} + } ], "since": "4.4" }, @@ -29235,33 +29413,39 @@ "name": "listPods", "params": [ { - "description": "list Pods by ID", + "description": "", "length": 255, - "name": "id", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list Pods by name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list pods by allocation state", + "length": 255, + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "list Pods by name", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "list Pods by Zone ID", @@ -29279,49 +29463,16 @@ "type": "boolean" }, { - "description": "list pods by allocation state", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", + "description": "list Pods by ID", "length": 255, - "name": "keyword", + "name": "id", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" } ], "related": "updatePod,createManagementNetworkIpRange", "response": [ - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, - {}, - {}, - { - "description": "the name of the Pod", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the IP ranges for the Pod", "name": "ipranges", @@ -29337,31 +29488,51 @@ "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the starting IP for the range", + "name": "startip", "type": "string" } ], "type": "list" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" + }, + { + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the Pod", + "name": "name", "type": "string" }, { @@ -29369,15 +29540,16 @@ "name": "gateway", "type": "string" }, + {}, { "description": "the ID of the Pod", "name": "id", "type": "string" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" + "description": "the 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.", @@ -29385,8 +29557,8 @@ "type": "list" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -29395,47 +29567,38 @@ "type": "list" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" }, { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" }, + {}, { "description": "the capacity of the Pod", "name": "capacity", "response": [ - { - "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 percentage of capacity currently in use", "name": "percentused", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { @@ -29443,11 +29606,6 @@ "name": "name", "type": "string" }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, { "description": "the Cluster ID", "name": "clusterid", @@ -29459,14 +29617,34 @@ "type": "short" }, { - "description": "the Cluster name", - "name": "clustername", + "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 capacity currently in use", + "name": "capacityused", + "type": "long" + }, { "description": "the capacity currently in allocated", "name": "capacityallocated", "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" } ], "type": "list" @@ -29490,38 +29668,43 @@ "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the gateway for the router", - "name": "gateway", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { @@ -29530,23 +29713,54 @@ "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + {}, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the host ID for the router", "name": "hostid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { @@ -29555,18 +29769,71 @@ "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { @@ -29574,38 +29841,38 @@ "name": "nic", "response": [ { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "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": "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", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -29614,19 +29881,19 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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 name of the corresponding network", @@ -29634,14 +29901,14 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { "description": "Id of the vpc to which the nic belongs", @@ -29649,28 +29916,38 @@ "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": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -29679,38 +29956,33 @@ "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -29719,31 +29991,26 @@ "type": "list" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" } ], "type": "set" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -29752,64 +30019,58 @@ "type": "integer" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the version of template", + "name": "version", "type": "string" }, { @@ -29817,138 +30078,55 @@ "name": "guestnetworkid", "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the project name of the address", + "name": "project", "type": "string" }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, { "description": "true if any health checks had failed", "name": "healthchecksfailed", "type": "boolean" }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, { "description": "the state of redundant virtual router", "name": "redundantstate", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" } ] }, @@ -29958,117 +30136,88 @@ "name": "updateDiskOffering", "params": [ { - "description": "bytes write rate of the disk offering", + "description": "the cache mode to use for this disk offering", "length": 255, - "name": "byteswriterate", + "name": "cachemode", "required": false, "since": "4.15", - "type": "long" + "type": "string" }, { - "description": "io requests write rate of the disk offering", + "description": "updates name of the disk offering with this value", "length": 255, - "name": "iopswriterate", + "name": "name", "required": false, - "since": "4.15", - "type": "long" + "type": "string" }, { - "description": "burst bytes write rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "byteswriteratemax", + "name": "iopswriteratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", - "required": false, - "since": "4.13", - "type": "string" - }, - { - "description": "updates name of the disk offering with this value", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "ID of the disk offering", "length": 255, - "name": "displayoffering", - "required": false, - "type": "boolean" + "name": "id", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" }, { "description": "length (in seconds) of the burst", "length": 255, - "name": "bytesreadratemaxlength", + "name": "byteswriteratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "zoneid", + "name": "byteswriterate", "required": false, - "since": "4.13", - "type": "string" + "since": "4.15", + "type": "long" }, { - "description": "the cache mode to use for this disk offering", + "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", "length": 255, - "name": "cachemode", + "name": "tags", "required": false, "since": "4.15", "type": "string" }, { - "description": "sort key of the disk offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, - { - "description": "length (in seconds) of the burst", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "iopswriteratemaxlength", + "name": "bytesreadratemax", "required": false, "since": "4.15", "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "iopsreadratemax", "required": false, "since": "4.15", "type": "long" }, { - "description": "ID of the disk offering", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "id", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "updates alternate display text of the disk offering with this value", - "length": 4096, - "name": "displaytext", + "name": "iopswriteratemax", "required": false, - "type": "string" + "since": "4.15", + "type": "long" }, { - "description": "io requests read rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "iopsreadrate", + "name": "iopsreadratemaxlength", "required": false, "since": "4.15", "type": "long" @@ -30082,41 +30231,70 @@ "type": "long" }, { - "description": "burst requests read rate of the disk offering", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "iopsreadratemax", + "name": "iopswriterate", "required": false, "since": "4.15", "type": "long" }, { - "description": "burst io requests write rate of the disk offering", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "iopswriteratemax", + "name": "displayoffering", "required": false, - "since": "4.15", - "type": "long" + "type": "boolean" }, { "description": "length (in seconds) of the burst", "length": 255, - "name": "byteswriteratemaxlength", + "name": "bytesreadratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "description": "updates alternate display text of the disk offering with this value", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "sort key of the disk offering, integer", "length": 255, - "name": "tags", + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "burst bytes write rate of the disk offering", + "length": 255, + "name": "byteswriteratemax", "required": false, "since": "4.15", + "type": "long" + }, + { + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, + "since": "4.13", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, - "name": "bytesreadratemax", + "name": "zoneid", + "required": false, + "since": "4.13", + "type": "string" + }, + { + "description": "io requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", "required": false, "since": "4.15", "type": "long" @@ -30124,49 +30302,44 @@ ], "related": "createDiskOffering,listDiskOfferings", "response": [ - { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" - }, { "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "the name of the disk offering", + "name": "name", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the tags for the disk offering", + "name": "tags", + "type": "string" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "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 zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { @@ -30175,28 +30348,23 @@ "type": "string" }, { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" - }, - { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the date this disk offering 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" }, { @@ -30205,101 +30373,91 @@ "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", "type": "boolean" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "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": "unique ID of the disk offering", "name": "id", "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, + {}, { "description": "burst bytes write rate of the disk offering", "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "the size of the disk offering in GB", + "name": "disksize", "type": "long" }, - {}, { "description": "true if disk offering uses custom iops, false otherwise", "name": "iscustomizediops", "type": "boolean" }, { - "description": "the name of the disk offering", - "name": "name", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", "type": "boolean" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", @@ -30307,13 +30465,33 @@ "type": "string" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", + "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 storage type for this disk offering", + "name": "storagetype", + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" + }, + { + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" + }, + { + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", "type": "long" } ] @@ -30323,13 +30501,6 @@ "isasync": true, "name": "deleteTungstenFabricAddressGroup", "params": [ - { - "description": "the uuid of Tungsten-Fabric address group", - "length": 255, - "name": "addressgroupuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -30337,13 +30508,21 @@ "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric address group", + "length": 255, + "name": "addressgroupuuid", + "required": true, + "type": "string" } ], "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { @@ -30351,18 +30530,169 @@ "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 quota tariff plans", + "isasync": false, + "name": "quotaTariffList", + "params": [ + { + "description": "The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2021-11-03.", + "length": 255, + "name": "enddate", + "required": false, + "since": "4.18.0.0", + "type": "date" + }, + { + "description": "Usage type of the resource", + "length": 255, + "name": "usagetype", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "The start date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, + { + "description": "The name of the quota tariff.", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0.0", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "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": "listall", + "required": false, + "since": "4.18.0.0", "type": "boolean" + } + ], + "related": "quotaTariffUpdate,quotaTariffCreate", + "response": [ + { + "description": "name", + "name": "name", + "type": "string" }, - {} - ] + { + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" + }, + {}, + { + "description": "usageDiscriminator", + "name": "usageDiscriminator", + "type": "string" + }, + { + "description": "usageUnit", + "name": "usageUnit", + "type": "string" + }, + { + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" + }, + {}, + { + "description": "usage type description", + "name": "usageTypeDescription", + "type": "string" + }, + { + "description": "usageType", + "name": "usageType", + "type": "int" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "description", + "name": "description", + "type": "string" + }, + { + "description": "uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "activation rule of the quota tariff", + "name": "activationRule", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "usageName", + "name": "usageName", + "type": "string" + }, + { + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" + }, + { + "description": "currency", + "name": "currency", + "type": "string" + }, + { + "description": "the start date of the quota tariff", + "name": "effectiveDate", + "type": "date" + } + ], + "since": "4.7.0" }, { "description": "Stops a running CloudManaged Kubernetes cluster", @@ -30379,6 +30709,12 @@ } ], "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -30389,18 +30725,12 @@ "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { @@ -30409,19 +30739,11 @@ "name": "removeVirtualMachinesFromKubernetesCluster", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" - }, - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" + "type": "string" }, { "description": "the IDs of the VMs to remove from the cluster", @@ -30432,11 +30754,19 @@ "type": "list" }, { - "description": "List by keyword", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "keyword", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -30448,6 +30778,18 @@ ], "related": "", "response": [ + {}, + {}, + { + "description": "the id of the Kubernetes cluster", + "name": "id", + "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", @@ -30458,23 +30800,11 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the id of the Kubernetes cluster", - "name": "id", - "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.19.0" }, @@ -30490,14 +30820,6 @@ "required": false, "type": "string" }, - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" - }, { "description": "ID of the project to add the account to", "length": 255, @@ -30519,31 +30841,39 @@ "name": "email", "required": false, "type": "string" + }, + { + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "createProjectRole,listProjectRoles,updateProjectRole", + "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "3.0.0" }, @@ -30553,88 +30883,88 @@ "name": "listSnapshots", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "ID of the image or image cache store", + "description": "lists snapshot by snapshot name", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "name": "name", "required": false, - "since": "4.19", - "type": "uuid" + "type": "string" }, { - "description": "the ID of the disk volume", + "description": "list snapshots by zone id", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "locationtype", + "name": "account", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "If set to false, list templates across zones and their storages", "length": 255, - "name": "listall", + "name": "showunique", "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", "length": 255, - "name": "account", + "name": "intervaltype", "required": false, "type": "string" }, { - "description": "lists snapshot by snapshot name", + "description": "ID of the image or image cache store", "length": 255, - "name": "name", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": false, - "type": "string" + "since": "4.19", + "type": "uuid" }, { - "description": "ID of the storage pool", + "description": "valid values are MANUAL or RECURRING.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "snapshottype", "required": false, - "since": "4.19", - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the IDs of the snapshots, mutually exclusive with id", "length": 255, - "name": "page", + "name": "ids", + "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", "required": false, - "type": "integer" + "since": "4.9", + "type": "list" }, { - "description": "List by keyword", + "description": "the ID of the disk volume", "length": 255, - "name": "keyword", + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, - "type": "string" + "type": "uuid" }, { "description": "List resources by tags (key/value pairs)", @@ -30644,19 +30974,13 @@ "type": "map" }, { - "description": "If set to false, list templates across zones and their storages", - "length": 255, - "name": "showunique", - "required": false, - "since": "4.19.0", - "type": "boolean" - }, - { - "description": "", + "description": "ID of the storage pool", "length": 255, - "name": "pagesize", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "integer" + "since": "4.19", + "type": "uuid" }, { "description": "list only resources belonging to the domain specified", @@ -30667,35 +30991,41 @@ "type": "uuid" }, { - "description": "valid values are MANUAL or RECURRING.", + "description": "List by keyword", "length": 255, - "name": "snapshottype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list snapshots by zone id", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "description": "", "length": 255, - "name": "intervaltype", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the IDs of the snapshots, mutually exclusive with id", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "ids", - "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", + "name": "isrecursive", "required": false, - "since": "4.9", - "type": "list" + "type": "boolean" + }, + { + "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", + "length": 255, + "name": "locationtype", + "required": false, + "since": "4.19.0", + "type": "string" }, { "description": "lists snapshot by snapshot ID", @@ -30709,106 +31039,54 @@ "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", "response": [ { - "description": "the project name of the snapshot", - "name": "project", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "name of the snapshot", - "name": "name", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "ID of the snapshot", + "name": "id", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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 list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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 domain name of the snapshot's account", + "name": "domain", + "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { "description": "state of the snapshot on the datastore", @@ -30816,111 +31094,163 @@ "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "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": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "id of the os on volume", + "name": "ostypeid", "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": " the date the snapshot was created", "name": "created", "type": "date" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" }, - {}, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "name of the disk volume", + "name": "volumename", "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": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, - {}, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, + {}, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -30930,44 +31260,44 @@ "name": "deleteTungstenFabricLogicalRouter", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric logical router", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "logicalrouteruuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric logical router", + "description": "the ID of zone", "length": 255, - "name": "logicalrouteruuid", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "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": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -30975,13 +31305,6 @@ "isasync": true, "name": "resetVpnConnection", "params": [ - { - "description": "an optional account for connection. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", "length": 255, @@ -30997,126 +31320,143 @@ "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", "required": true, "type": "uuid" + }, + { + "description": "an optional account for connection. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "response": [ { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "is connection for display to the regular user", + "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "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": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, + { + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, { "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the project id", + "name": "projectid", "type": "string" }, - {}, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the owner", - "name": "account", + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" + }, + { + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, + {}, + {}, { "description": "the connection ID", "name": "id", "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the project name", - "name": "project", + "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 created", "name": "created", "type": "date" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the project name", + "name": "project", + "type": "string" }, { "description": "Lifetime of IKE SA of customer gateway", @@ -31125,18 +31465,8 @@ }, { "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, - { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "name": "state", + "type": "string" } ] }, @@ -31146,20 +31476,20 @@ "name": "migrateResourceToAnotherSecondaryStorage", "params": [ { - "description": "id of the image store from where the data is to be migrated", + "description": "id of the destination secondary storage pool to which the resources are to be migrated", "length": 255, - "name": "srcpool", + "name": "destpool", "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": true, "type": "uuid" }, { - "description": "id of the destination secondary storage pool to which the resources are to be migrated", + "description": "id(s) of the snapshots to be migrated", "length": 255, - "name": "destpool", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" + "name": "snapshots", + "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", + "required": false, + "type": "list" }, { "description": "id(s) of the templates to be migrated", @@ -31170,42 +31500,42 @@ "type": "list" }, { - "description": "id(s) of the snapshots to be migrated", + "description": "id of the image store from where the data is to be migrated", "length": 255, - "name": "snapshots", - "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", - "required": false, - "type": "list" + "name": "srcpool", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": true, + "type": "uuid" } ], "related": "migrateSecondaryStorageData", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Type of migration requested for", + "name": "migrationtype", + "type": "string" }, + {}, { "description": "Response message from migration of secondary storage data objects", "name": "message", "type": "string" }, - { - "description": "Type of migration requested for", - "name": "migrationtype", - "type": "string" - }, - {}, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.19.0" @@ -31216,33 +31546,19 @@ "name": "listKubernetesClusters", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "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": "listall", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", @@ -31252,17 +31568,16 @@ "type": "integer" }, { - "description": "the ID of the Kubernetes cluster", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "state of the Kubernetes cluster", "length": 255, - "name": "account", + "name": "state", "required": false, "type": "string" }, @@ -31274,18 +31589,19 @@ "type": "integer" }, { - "description": "state of the Kubernetes cluster", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "state", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "name", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "type of the cluster: CloudManaged, ExternalManaged", @@ -31296,105 +31612,129 @@ "type": "string" }, { - "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": "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 by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "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": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "Public IP Address of the cluster", + "name": "ipaddress", + "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, + { + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "type": "long" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { "description": "the name of the Kubernetes version for the Kubernetes cluster", @@ -31402,50 +31742,56 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "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", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" }, { "description": "Whether autoscaling is enabled for the cluster", @@ -31453,46 +31799,30 @@ "type": "boolean" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" - }, - { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" - }, - { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", - "type": "string" - }, - { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "keypair details", + "name": "keypair", "type": "string" - }, - {} + } ] }, { @@ -31500,6 +31830,13 @@ "isasync": false, "name": "deleteSSHKeyPair", "params": [ + { + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "the project associated with keypair", "length": 255, @@ -31522,21 +31859,13 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" - }, - { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], "response": [ - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -31544,16 +31873,17 @@ "type": "integer" }, {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ] }, { @@ -31562,12 +31892,11 @@ "name": "createAutoScaleVmGroup", "params": [ { - "description": "list of scaledown autoscale policies", + "description": "the frequency in which the performance counters to be collected", "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "list" + "name": "interval", + "required": false, + "type": "integer" }, { "description": "list of scaleup autoscale policies", @@ -31586,18 +31915,12 @@ "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "description": "list of scaledown autoscale policies", "length": 255, - "name": "minmembers", + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, - "type": "integer" - }, - { - "description": "the frequency in which the performance counters to be collected", - "length": 255, - "name": "interval", - "required": false, - "type": "integer" + "type": "list" }, { "description": "the autoscale profile that contains information about the vms in the vm group.", @@ -31607,6 +31930,13 @@ "required": true, "type": "uuid" }, + { + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "length": 255, + "name": "minmembers", + "required": true, + "type": "integer" + }, { "description": "an optional field, whether to the display the group to the end user or not", "length": 255, @@ -31619,7 +31949,7 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" }, @@ -31634,43 +31964,54 @@ "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" + }, + { + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, + { + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + }, { "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", "name": "availablevirtualmachinecount", "type": "int" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the public ip address", + "name": "publicip", "type": "string" }, + {}, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -31679,8 +32020,18 @@ "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" + }, + { + "description": "the name of the autoscale vm group ", + "name": "name", + "type": "string" + }, + { + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { @@ -31689,91 +32040,70 @@ "type": "date" }, { - "description": "the public port", - "name": "publicport", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" }, { "description": "the account owning the vm group", "name": "account", "type": "string" }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, { "description": "is group for display to the regular user", "name": "fordisplay", "type": "boolean" }, - { - "description": "the project name of the vm group", - "name": "project", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" - }, - { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, + {}, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the public ip address", - "name": "publicip", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" } ] }, @@ -31783,11 +32113,10 @@ "name": "searchLdap", "params": [ { - "description": "query to search using", + "description": "List by keyword", "length": 255, - "name": "query", - "related": "searchLdap,listLdapUsers", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { @@ -31798,10 +32127,11 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "query to search using", "length": 255, - "name": "keyword", - "required": false, + "name": "query", + "related": "searchLdap,listLdapUsers", + "required": true, "type": "string" }, { @@ -31815,31 +32145,24 @@ "related": "listLdapUsers", "response": [ { - "description": "The user's lastname", - "name": "lastname", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The user's email", - "name": "email", + "description": "The user's username", + "name": "username", "type": "string" }, - {}, - {}, { - "description": "The user's firstname", - "name": "firstname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The user's username", - "name": "username", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "The user's domain", @@ -31847,18 +32170,25 @@ "type": "string" }, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, + {}, { "description": "The user's principle", "name": "principal", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", + "type": "string" + }, + {}, + { + "description": "The user's email", + "name": "email", "type": "string" } ], @@ -31881,36 +32211,36 @@ "related": "prepareForShutdown,triggerShutdown", "response": [ { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + }, + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "long" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", "type": "boolean" }, {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" - }, - { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" } ], "since": "4.19.0" @@ -31924,28 +32254,28 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" } ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "the 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", @@ -31967,6 +32297,20 @@ "required": false, "type": "uuid" }, + { + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "PING storage server ip", + "length": 255, + "name": "pingstorageserverip", + "required": true, + "type": "string" + }, { "description": "Password of PING storage server", "length": 255, @@ -31975,9 +32319,9 @@ "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "password", + "name": "tftpdir", "required": true, "type": "string" }, @@ -31989,10 +32333,10 @@ "type": "string" }, { - "description": "Username of PING storage server", + "description": "Root directory on PING storage server", "length": 255, - "name": "pingcifsusername", - "required": false, + "name": "pingdir", + "required": true, "type": "string" }, { @@ -32002,13 +32346,6 @@ "required": true, "type": "string" }, - { - "description": "Tftp root directory of PXE server", - "length": 255, - "name": "tftpdir", - "required": true, - "type": "string" - }, { "description": "the Physical Network ID", "length": 255, @@ -32018,10 +32355,10 @@ "type": "uuid" }, { - "description": "Root directory on PING storage server", + "description": "Username of PING storage server", "length": 255, - "name": "pingdir", - "required": true, + "name": "pingcifsusername", + "required": false, "type": "string" }, { @@ -32030,17 +32367,21 @@ "name": "url", "required": true, "type": "string" - }, - { - "description": "PING storage server ip", - "length": 255, - "name": "pingstorageserverip", - "required": true, - "type": "string" } ], "related": "", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "url", + "name": "url", + "type": "string" + }, { "description": "Root directory on PING storage server", "name": "pingdir", @@ -32051,12 +32392,6 @@ "name": "tftpdir", "type": "string" }, - {}, - { - "description": "device id of ", - "name": "id", - "type": "string" - }, { "description": "the physical network to which this external dhcp device belongs to", "name": "physicalnetworkid", @@ -32067,22 +32402,17 @@ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "url", - "name": "url", + "description": "PING storage server ip", + "name": "pingstorageserverip", "type": "string" }, { - "description": "PING storage server ip", - "name": "pingstorageserverip", + "description": "device id of ", + "name": "id", "type": "string" }, + {}, { "description": "name of the provider", "name": "provider", @@ -32113,9 +32443,10 @@ ], "related": "addTungstenFabricNetworkGatewayToLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", "response": [ + {}, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -32123,32 +32454,31 @@ "name": "network", "type": "list" }, - {}, { - "description": "Tungsten-Fabric logical router name", - "name": "name", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric logical router name", + "name": "name", + "type": "string" } ] }, @@ -32158,131 +32488,120 @@ "name": "createTungstenFabricFirewallRule", "params": [ { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "Tungsten-Fabric firewall rule direction", + "description": "Tungsten-Fabric firewall rule service group uuid", "length": 255, - "name": "direction", + "name": "servicegroupuuid", "required": true, "type": "string" }, { - "description": "the sequence of Tungsten-Fabric firewall rule", + "description": "Tungsten-Fabric firewall rule source tag uuid", "length": 255, - "name": "sequence", - "required": true, - "type": "integer" + "name": "srctaguuid", + "required": false, + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "Tungsten-Fabric firewall rule source address group uuid", "length": 255, - "name": "firewallpolicyuuid", - "required": true, + "name": "srcaddressgroupuuid", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", + "description": "Tungsten-Fabric firewall rule destination address group uuid", "length": 255, - "name": "action", - "required": true, + "name": "destaddressgroupuuid", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag uuid", + "description": "the uuid of Tungsten-Fabric destination network", "length": 255, - "name": "desttaguuid", + "name": "destnetworkuuid", "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", + "description": "the sequence of Tungsten-Fabric firewall rule", "length": 255, - "name": "name", + "name": "sequence", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric source network", + "description": "Tungsten-Fabric firewall rule tag type uuid", "length": 255, - "name": "srcnetworkuuid", + "name": "tagtypeuuid", "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source tag uuid", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "srctaguuid", - "required": false, + "name": "firewallpolicyuuid", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type uuid", + "description": "Tungsten-Fabric firewall rule action", "length": 255, - "name": "tagtypeuuid", - "required": false, + "name": "action", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group uuid", + "description": "Tungsten-Fabric firewall rule destination tag uuid", "length": 255, - "name": "servicegroupuuid", - "required": true, + "name": "desttaguuid", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source address group uuid", + "description": "the uuid of Tungsten-Fabric source network", "length": 255, - "name": "srcaddressgroupuuid", + "name": "srcnetworkuuid", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric destination network", + "description": "Tungsten-Fabric firewall rule name", "length": 255, - "name": "destnetworkuuid", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination address group uuid", + "description": "Tungsten-Fabric firewall rule direction", "length": 255, - "name": "destaddressgroupuuid", - "required": false, + "name": "direction", + "required": true, "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" } ], "related": "listTungstenFabricFirewallRule", "response": [ - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule source tag", - "name": "srctag", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" }, { @@ -32291,20 +32610,22 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", - "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", @@ -32331,15 +32652,24 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", + "type": "string" } ] }, @@ -32355,14 +32685,6 @@ "required": false, "type": "integer" }, - { - "description": "Id of the portable ip range", - "length": 255, - "name": "id", - "related": "createPortableIpRange,listPortableIpRanges", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -32377,6 +32699,14 @@ "required": false, "type": "string" }, + { + "description": "Id of the portable ip range", + "length": 255, + "name": "id", + "related": "createPortableIpRange,listPortableIpRanges", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -32387,39 +32717,44 @@ ], "related": "createPortableIpRange", "response": [ - {}, + { + "description": "portable IP range ID", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the ID or VID of the VLAN.", "name": "vlan", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the start ip of the portable IP range", + "name": "startip", "type": "string" }, { - "description": "portable IP range ID", - "name": "id", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, + {}, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" }, { "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", "name": "portableipaddress", "response": [ { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { @@ -32428,18 +32763,18 @@ "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", - "type": "string" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", "type": "string" }, { @@ -32448,48 +32783,43 @@ "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", - "name": "state", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "VPC the ip belongs to", + "name": "vpcid", + "type": "string" } ], "type": "list" }, - { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", - "type": "integer" - }, - {}, - { - "description": "the start ip of the portable IP range", - "name": "startip", - "type": "string" - }, { "description": "the end ip of the portable IP range", "name": "endip", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" } ] }, @@ -32509,6 +32839,7 @@ ], "related": "", "response": [ + {}, { "description": "the ID of the virtual machine", "name": "virtualmachineid", @@ -32519,18 +32850,17 @@ "name": "userdata", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ], "since": "4.4" }, @@ -32539,6 +32869,14 @@ "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": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, @@ -32548,51 +32886,43 @@ "type": "list" }, { - "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "accounts", + "name": "accountids", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "list" }, { - "description": "the network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - }, - { - "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "accountids", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "accounts", "required": false, "type": "list" } ], "response": [ + {}, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.17.0" @@ -32602,14 +32932,6 @@ "isasync": false, "name": "listConfigurations", "params": [ - { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, { "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, @@ -32619,11 +32941,12 @@ "type": "uuid" }, { - "description": "lists configuration by name", + "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, - "name": "name", + "name": "imagestoreuuid", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -32640,19 +32963,12 @@ "type": "string" }, { - "description": "lists configuration by parent name (primarily used for UI)", - "length": 255, - "name": "parent", - "required": false, - "since": "4.18.0", - "type": "string" - }, - { - "description": "", + "description": "the ID of the Domain to update the parameter value for corresponding domain", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", @@ -32663,48 +32979,62 @@ "type": "uuid" }, { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "description": "List by keyword", "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists configuration by group name (primarily used for UI)", + "description": "lists configuration by subgroup name (primarily used for UI)", "length": 255, - "name": "group", + "name": "subgroup", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "List by keyword", + "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "lists configuration by name", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "the ID of the Domain to update the parameter value for corresponding domain", + "description": "lists configuration by parent name (primarily used for UI)", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "parent", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "lists configuration by subgroup name (primarily used for UI)", + "description": "", "length": 255, - "name": "subgroup", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "lists configuration by group name (primarily used for UI)", + "length": 255, + "name": "group", "required": false, "since": "4.18.0", "type": "string" @@ -32713,91 +33043,91 @@ "related": "updateConfiguration", "response": [ { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the description of the configuration", - "name": "description", + "description": "the group of the configuration", + "name": "group", "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", - "type": "string" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { - "description": "the value of the configuration", - "name": "id", - "type": "long" + "description": "the display text of the configuration", + "name": "displaytext", + "type": "string" }, + {}, + {}, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the component of the configuration", + "name": "component", "type": "string" }, { - "description": "the group of the configuration", - "name": "group", + "description": "the type of the configuration value", + "name": "type", "type": "string" }, - {}, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the possible options of the configuration value", + "name": "options", + "type": "string" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { - "description": "the component of the configuration", - "name": "component", + "description": "the name of the configuration", + "name": "name", "type": "string" }, - {}, { "description": "the value of the configuration", "name": "value", "type": "string" }, { - "description": "the name of the configuration", - "name": "name", + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the description of the configuration", + "name": "description", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the value of the configuration", + "name": "id", + "type": "long" } ] }, @@ -32816,28 +33146,28 @@ } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + { + "description": "the 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" + } ] }, { @@ -32863,49 +33193,195 @@ ], "related": "", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the vm", + "name": "virtualmachineid", + "type": "string" + }, { "description": "the ID of the secondary private IP addr", "name": "id", "type": "string" }, - {}, + { + "description": "the list of Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the network", + "name": "networkid", + "type": "string" + }, + {}, { "description": "the ID of the nic", "name": "nicid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Secondary IP address", + "name": "ipaddress", + "type": "string" + }, + {} + ] + }, + { + "description": "Update the tariff plan for a resource", + "isasync": false, + "name": "quotaTariffUpdate", + "params": [ + { + "description": "The quota tariff value of the resource as per the default unit.", + "length": 255, + "name": "value", + "required": false, + "type": "double" + }, + { + "description": "DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, + { + "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. Use yyyy-MM-dd as the date format, e.g. endDate=2009-06-03.", + "length": 255, + "name": "enddate", + "required": false, + "since": "4.18.0.0", + "type": "date" + }, + { + "description": "DEPRECATED. Integer value for the usage type of the resource", + "length": 255, + "name": "usagetype", + "required": false, + "type": "integer" + }, + { + "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule.", + "length": 65535, + "name": "activationrule", + "required": false, + "since": "4.18.0.0", "type": "string" }, + { + "description": "Quota tariff's description. Inform empty to remove the description.", + "length": 65535, + "name": "description", + "required": false, + "since": "4.18.0.0", + "type": "string" + } + ], + "related": "quotaTariffCreate", + "response": [ {}, { - "description": "the list of Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "usageUnit", + "name": "usageUnit", + "type": "string" }, { - "description": "the ID of the vm", - "name": "virtualmachineid", + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" + }, + { + "description": "currency", + "name": "currency", "type": "string" }, { - "description": "the ID of the network", - "name": "networkid", + "description": "usageDiscriminator", + "name": "usageDiscriminator", "type": "string" }, { - "description": "Secondary IP address", - "name": "ipaddress", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "activation rule of the quota tariff", + "name": "activationRule", + "type": "string" + }, + { + "description": "usageName", + "name": "usageName", + "type": "string" + }, + { + "description": "the start date of the quota tariff", + "name": "effectiveDate", + "type": "date" + }, + { + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" + }, + { + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" + }, + { + "description": "name", + "name": "name", + "type": "string" + }, + { + "description": "uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "description", + "name": "description", + "type": "string" + }, + { + "description": "usageType", + "name": "usageType", + "type": "int" + }, + {}, + { + "description": "usage type description", + "name": "usageTypeDescription", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.7.0" }, { "description": "Scales a created, running or stopped CloudManaged Kubernetes cluster", @@ -32921,19 +33397,19 @@ "type": "uuid" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "Maximum number of worker nodes in the cluster", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "maxsize", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "Whether autoscaling is enabled for the cluster", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "autoscalingenabled", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the IDs of the nodes to be removed", @@ -32944,23 +33420,23 @@ "type": "list" }, { - "description": "Minimum number of worker nodes in the cluster", + "description": "Whether autoscaling is enabled for the cluster", "length": 255, - "name": "minsize", + "name": "autoscalingenabled", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "number of Kubernetes cluster nodes", + "description": "Minimum number of worker nodes in the cluster", "length": 255, - "name": "size", + "name": "minsize", "required": false, "type": "long" }, { - "description": "Maximum number of worker nodes in the cluster", + "description": "number of Kubernetes cluster nodes", "length": 255, - "name": "maxsize", + "name": "size", "required": false, "type": "long" } @@ -32968,39 +33444,41 @@ "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "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": "zoneid", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "keypair details", + "name": "keypair", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" }, { "description": "the name of the service offering of the Kubernetes cluster", @@ -33008,90 +33486,88 @@ "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, + { + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", "type": "long" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - {}, - { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "keypair details", - "name": "keypair", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { @@ -33100,24 +33576,24 @@ "type": "boolean" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "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 control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { "description": "the state of the Kubernetes cluster", @@ -33125,33 +33601,33 @@ "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" } ] @@ -33180,119 +33656,110 @@ "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, { "description": "the public MAC address for the router", "name": "publicmacaddress", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "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": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the hostname for the router", - "name": "hostname", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the Pod name for the router", + "name": "podname", "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 public IP address for the router", - "name": "publicip", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the guest netmask for the router", + "name": "guestnetmask", "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 state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { @@ -33300,34 +33767,14 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, { "description": "VPC the router belongs to", "name": "vpcid", "type": "string" }, { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { @@ -33336,13 +33783,18 @@ "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { @@ -33350,53 +33802,53 @@ "name": "nic", "response": [ { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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 broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -33405,48 +33857,43 @@ "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -33455,34 +33902,29 @@ "type": "boolean" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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 type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "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 (if NSX based), null otherwise", @@ -33495,21 +33937,72 @@ "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" } ], "type": "set" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "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 version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -33518,14 +34011,14 @@ "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, { "description": "the ID of the service offering of the virtual machine", @@ -33533,96 +34026,64 @@ "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, - {}, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the domain associated with the router", + "name": "domain", "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 type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - } - ], - "type": "list" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "role of the domain router", + "name": "role", "type": "string" }, + {}, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, { "description": "the first IPv6 DNS for the router", "name": "ip6dns1", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { @@ -33631,13 +34092,28 @@ "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the version of template", - "name": "version", + "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 hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", "type": "string" } ] @@ -33657,23 +34133,23 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { "description": "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", @@ -33687,12 +34163,11 @@ "name": "deleteHost", "params": [ { - "description": "the host ID", + "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" + "name": "forcedestroylocalstorage", + "required": false, + "type": "boolean" }, { "description": "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped", @@ -33702,43 +34177,44 @@ "type": "boolean" }, { - "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", + "description": "the host ID", "length": 255, - "name": "forcedestroylocalstorage", - "required": false, - "type": "boolean" + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "required": true, + "type": "uuid" } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Deletes a vm group", - "isasync": false, - "name": "deleteInstanceGroup", - "params": [ + {} + ] + }, + { + "description": "Deletes a vm group", + "isasync": false, + "name": "deleteInstanceGroup", + "params": [ { "description": "the ID of the instance group", "length": 255, @@ -33749,27 +34225,27 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, {} ] }, @@ -33779,21 +34255,26 @@ "name": "deleteResourceIcon", "params": [ { - "description": "type of the resource", + "description": "list of resources to upload the icon/image for", "length": 255, - "name": "resourcetype", + "name": "resourceids", "required": true, - "type": "string" + "type": "list" }, { - "description": "list of resources to upload the icon/image for", + "description": "type of the resource", "length": 255, - "name": "resourceids", + "name": "resourcetype", "required": true, - "type": "list" + "type": "string" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -33801,20 +34282,15 @@ }, {}, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "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.16.0.0" @@ -33827,8 +34303,23 @@ "related": "", "response": [ { - "description": "true if snapshot is supported for KVM host, false otherwise", - "name": "kvmsnapshotenabled", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", + "name": "allowuserviewdestroyedvm", + "type": "boolean" + }, + { + "description": "the retention time for Instances stats", + "name": "instancesstatsretentiontime", + "type": "integer" + }, + { + "description": "true if dynamic role-based api checker is enabled, false otherwise", + "name": "dynamicrolesenabled", "type": "boolean" }, { @@ -33837,23 +34328,39 @@ "type": "boolean" }, { - "description": "true if users can see all accounts within the same domain, false otherwise", - "name": "allowuserviewalldomainaccounts", + "description": "true if the user can recover and expunge virtualmachines, false otherwise", + "name": "allowuserexpungerecovervm", "type": "boolean" }, + {}, { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", + "description": "true if snapshot is supported for KVM host, false otherwise", + "name": "kvmsnapshotenabled", "type": "boolean" }, { - "description": "time interval (in seconds) to reset api count", - "name": "apilimitinterval", + "description": "the retention time for Instances disks stats", + "name": "instancesdisksstatsretentiontime", "type": "integer" }, { - "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", - "name": "kubernetesclusterexperimentalfeaturesenabled", + "description": "minimum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingminsize", + "type": "long" + }, + { + "description": "maximum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingmaxsize", + "type": "long" + }, + { + "description": "Display name for custom hypervisor", + "name": "customhypervisordisplayname", + "type": "string" + }, + { + "description": "true if Kubernetes Service plugin is enabled, false otherwise", + "name": "kubernetesserviceenabled", "type": "boolean" }, { @@ -33862,25 +34369,19 @@ "type": "long" }, { - "description": "true if the user can recover and expunge virtualmachines, false otherwise", - "name": "allowuserexpungerecovervm", + "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", + "name": "kubernetesclusterexperimentalfeaturesenabled", "type": "boolean" }, { - "description": "Max allowed number of api requests within the specified interval", - "name": "apilimitmax", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "maximum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingmaxsize", - "type": "long" - }, { - "description": "minimum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingminsize", - "type": "long" + "description": "version of the cloud stack", + "name": "cloudstackversion", + "type": "string" }, { "description": "true if region supports elastic load balancer on basic zones", @@ -33892,45 +34393,35 @@ "name": "allowusercreateprojects", "type": "boolean" }, + { + "description": "time interval (in seconds) to reset api count", + "name": "apilimitinterval", + "type": "integer" + }, + { + "description": "true if users can see all accounts within the same domain, false otherwise", + "name": "allowuserviewalldomainaccounts", + "type": "boolean" + }, + {}, { "description": "true if the user can recover and expunge volumes, false otherwise", "name": "allowuserexpungerecovervolume", "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", - "type": "boolean" - }, { "description": "true if stats are collected only for user instances, false if system instance stats are also collected", "name": "instancesstatsuseronly", "type": "boolean" }, { - "description": "version of the cloud stack", - "name": "cloudstackversion", - "type": "string" - }, - { - "description": "true if dynamic role-based api checker is enabled, false otherwise", - "name": "dynamicrolesenabled", - "type": "boolean" - }, - { - "description": "true if Kubernetes Service plugin is enabled, false otherwise", - "name": "kubernetesserviceenabled", - "type": "boolean" - }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "If invitation confirmation is required when add account to project", + "name": "projectinviterequired", "type": "boolean" }, { @@ -33938,96 +34429,41 @@ "name": "instancesdisksstatsretentionenabled", "type": "boolean" }, - { - "description": "the retention time for Instances disks stats", - "name": "instancesdisksstatsretentiontime", - "type": "integer" - }, { "description": "true if user and domain admins can set templates to be shared, false otherwise", "name": "userpublictemplateenabled", "type": "boolean" }, { - "description": "the retention time for Instances stats", - "name": "instancesstatsretentiontime", - "type": "integer" - }, - { - "description": "Display name for custom hypervisor", - "name": "customhypervisordisplayname", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Max allowed number of api requests within the specified interval", + "name": "apilimitmax", "type": "integer" } ] }, - { - "description": "Release dedication of zone", - "isasync": true, - "name": "releaseDedicatedZone", - "params": [ - { - "description": "the ID of the Zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - {} - ] - }, { "description": "Updates traffic type of a physical network", "isasync": true, "name": "updateTrafficType", "params": [ { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "length": 255, - "name": "kvmnetworklabel", + "name": "xennetworklabel", "required": false, "type": "string" }, { - "description": "traffic type id", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "id", - "related": "addTrafficType,updateTrafficType", - "required": true, - "type": "uuid" + "name": "hypervnetworklabel", + "required": false, + "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "length": 255, - "name": "xennetworklabel", + "name": "kvmnetworklabel", "required": false, "type": "string" }, @@ -34039,11 +34475,12 @@ "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "description": "traffic type id", "length": 255, - "name": "hypervnetworklabel", - "required": false, - "type": "string" + "name": "id", + "related": "addTrafficType,updateTrafficType", + "required": true, + "type": "uuid" }, { "description": "The network name label of the physical device dedicated to this traffic on a VMware host", @@ -34056,80 +34493,104 @@ "related": "addTrafficType", "response": [ { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", "type": "string" }, {}, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", - "type": "string" - }, - { - "description": "id of the network provider", - "name": "id", + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "description": "id of the network provider", + "name": "id", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "the trafficType to be added to the physical network", + "name": "traffictype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, { "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "name": "xennetworklabel", "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", + "type": "string" } ], "since": "3.0.0" }, { - "description": "List Conditions for VM auto scaling", - "isasync": false, - "name": "listConditions", + "description": "Release dedication of zone", + "isasync": true, + "name": "releaseDedicatedZone", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the Zone", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, + "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": "", - "length": 255, - "name": "page", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ] + }, + { + "description": "List Conditions for VM auto scaling", + "isasync": false, + "name": "listConditions", + "params": [ { "description": "the ID of the policy", "length": 255, @@ -34139,33 +34600,41 @@ "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": "", + "description": "Counter-id of the condition.", "length": 255, - "name": "pagesize", + "name": "counterid", + "related": "createCounter,listCounters", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Counter-id of the condition.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", + "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 account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -34182,6 +34651,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "ID of the Condition.", "length": 255, @@ -34191,44 +34667,43 @@ "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" } ], "related": "createCondition", "response": [ { - "description": "zone id of counter", - "name": "zoneid", + "description": "the Name of the Counter.", + "name": "countername", "type": "string" }, { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "the owner of the Condition.", + "name": "account", "type": "string" }, { - "description": "the Name of the Counter.", - "name": "countername", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the id of the Condition", - "name": "id", + "description": "the project name of the Condition", + "name": "project", "type": "string" }, { - "description": "the owner of the Condition.", - "name": "account", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, { @@ -34237,41 +34712,42 @@ "type": "string" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" + "description": "the id of the Condition", + "name": "id", + "type": "string" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" }, - {}, + { + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" + }, { "description": "Details of the Counter.", "name": "counter", "type": "counterresponse" }, - { - "description": "the project id of the Condition.", - "name": "projectid", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -34304,6 +34780,11 @@ ], "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "response": [ + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -34315,41 +34796,36 @@ "type": "integer" }, { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, + {}, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "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 provider name", "name": "name", "type": "string" }, + {}, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "since": "3.0.0" @@ -34362,84 +34838,101 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the id of the management server", + "description": "the name of the management server", "length": 255, - "name": "id", - "related": "listManagementServers", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "include system level stats", + "description": "List by keyword", "length": 255, - "name": "system", - "related": "listManagementServersMetrics", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "the id of the management server", "length": 255, - "name": "page", + "name": "id", + "related": "listManagementServers", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the name of the management server", + "description": "include system level stats", "length": 255, - "name": "name", + "name": "system", + "related": "listManagementServersMetrics", "required": false, - "type": "string" + "type": "boolean" } ], "related": "", "response": [ { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "the IP Address for this Management Server", + "name": "serviceip", + "type": "string" }, { - "description": "Total system memory", - "name": "systemmemorytotal", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the version of the management server", - "name": "version", + "description": "Virtual size of the fully loaded process", + "name": "systemmemoryvirtualsize", "type": "string" }, + {}, { - "description": "the log files and their usage on disk", - "name": "loginfo", + "description": "the current cpu load", + "name": "cpuload", "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": "the amount of memory allocated to this Management Server", + "name": "heapmemorytotal", + "type": "long" + }, { "description": "the name of the management server", "name": "name", "type": "string" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", + "description": "Free system memory", + "name": "systemmemoryfree", "type": "string" }, + {}, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" + "description": "the version of the management server", + "name": "version", + "type": "string" }, { "description": "the last time this Management Server was started", @@ -34447,28 +34940,23 @@ "type": "date" }, { - "description": "the IP Address for this Management Server", - "name": "serviceip", - "type": "string" - }, - { - "description": "the load averages for 1 5 and 15 minutes", - "name": "systemloadaverages", - "type": "double[]" + "description": "the number of processors available to the JVM", + "name": "availableprocessors", + "type": "integer" }, { - "description": "the number of client sessions active on this Management Server", - "name": "sessions", - "type": "long" + "description": "The number of terminated threads", + "name": "threadsteminatedcount", + "type": "integer" }, { - "description": "the total system cpu capacity", - "name": "systemtotalcpucycles", - "type": "double" + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "type": "string" }, { - "description": "the ID of the management server", - "name": "id", + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", "type": "string" }, { @@ -34477,122 +34965,110 @@ "type": "integer" }, { - "description": "The number of runnable threads", - "name": "threadsrunnablecount", + "description": "The number of threads", + "name": "threadstotalcount", "type": "integer" }, { - "description": "the current cpu load", - "name": "cpuload", - "type": "string" + "description": "the system is running against a local database", + "name": "dbislocal", + "type": "boolean" }, { - "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 blocked threads", - "name": "threadsblockedcount", - "type": "integer" + "description": "the version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" }, { - "description": "The number of waiting threads", - "name": "threadswaitingcount", - "type": "integer" + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" }, { - "description": "Free system memory", - "name": "systemmemoryfree", + "description": "Total system memory", + "name": "systemmemorytotal", "type": "string" }, { - "description": "the number of processors available to the JVM", - "name": "availableprocessors", - "type": "integer" - }, - { - "description": "The number of terminated threads", - "name": "threadsteminatedcount", - "type": "integer" + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" }, - {}, { - "description": "The number of threads", - "name": "threadstotalcount", + "description": "The number of runnable threads", + "name": "threadsrunnablecount", "type": "integer" }, { - "description": "the state of the management server", - "name": "state", - "type": "state" - }, - { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "the log files and their usage on disk", + "name": "loginfo", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Amount of memory used", + "name": "systemmemoryused", "type": "string" }, { - "description": "the system is running against a local database", - "name": "dbislocal", - "type": "boolean" + "description": "the amount of memory used by this Management Server", + "name": "heapmemoryused", + "type": "long" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", + "description": "the time these statistics were collected", + "name": "collectiontime", "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the number of client sessions active on this Management Server", + "name": "sessions", + "type": "long" }, { - "description": "the system load for user, and system processes and the system idle cycles", - "name": "systemcycleusage", - "type": "long[]" + "description": "the total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, { - "description": "the number of agents this Management Server is responsible for", - "name": "agentcount", - "type": "integer" + "description": "the system has a usage server running locally", + "name": "usageislocal", + "type": "boolean" }, { - "description": "Amount of memory used", - "name": "systemmemoryused", + "description": "the ID of the management server", + "name": "id", "type": "string" }, { - "description": "Virtual size of the fully loaded process", - "name": "systemmemoryvirtualsize", - "type": "string" + "description": "the number of agents this Management Server is responsible for", + "name": "agentcount", + "type": "integer" }, { - "description": "the system has a usage server running locally", - "name": "usageislocal", - "type": "boolean" + "description": "The number of blocked threads", + "name": "threadsblockedcount", + "type": "integer" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", - "type": "string" + "description": "the state of the management server", + "name": "state", + "type": "state" }, { - "description": "the amount of memory allocated to this Management Server", - "name": "heapmemorytotal", - "type": "long" - }, - {} + "description": "The number of waiting threads", + "name": "threadswaitingcount", + "type": "integer" + } ], "since": "4.17.0" }, @@ -34609,6 +35085,14 @@ "since": "4.4", "type": "map" }, + { + "description": "The ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" + }, { "description": "the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)", "length": 255, @@ -34616,39 +35100,31 @@ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, "type": "list" - }, - { - "description": "The ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -34657,18 +35133,12 @@ "name": "listInstanceGroups", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -34678,12 +35148,11 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", @@ -34693,19 +35162,12 @@ "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list instance groups by name", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -34715,11 +35177,11 @@ "type": "uuid" }, { - "description": "list instance groups by name", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "name", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list instance groups by ID", @@ -34728,28 +35190,48 @@ "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", "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, + "type": "string" } ], "related": "createInstanceGroup,updateInstanceGroup", "response": [ { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" + "description": "the domain name of the instance group", + "name": "domain", + "type": "string" }, + {}, { - "description": "the ID of the instance group", - "name": "id", + "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", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -34758,8 +35240,13 @@ "type": "string" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { @@ -34768,27 +35255,16 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, { - "description": "the name of the instance group", - "name": "name", + "description": "the ID of the instance group", + "name": "id", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -34797,20 +35273,20 @@ "name": "migrateSecondaryStorageData", "params": [ { - "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated", + "description": "id of the image store from where the data is to be migrated", "length": 255, - "name": "destpools", + "name": "srcpool", "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": true, - "type": "list" + "type": "uuid" }, { - "description": "id of the image store from where the data is to be migrated", + "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated", "length": 255, - "name": "srcpool", + "name": "destpools", "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": true, - "type": "uuid" + "type": "list" }, { "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", @@ -34823,32 +35299,32 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Type of migration requested for", + "name": "migrationtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Response message from migration of secondary storage data objects", + "name": "message", + "type": "string" }, {}, + { + "description": "the 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": "Response message from migration of secondary storage data objects", - "name": "message", - "type": "string" - }, - { - "description": "Type of migration requested for", - "name": "migrationtype", - "type": "string" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.15.0" }, @@ -34857,13 +35333,6 @@ "isasync": true, "name": "createStaticRoute", "params": [ - { - "description": "static route cidr", - "length": 255, - "name": "cidr", - "required": true, - "type": "string" - }, { "description": "the gateway id we are creating static route for", "length": 255, @@ -34871,69 +35340,55 @@ "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": true, "type": "uuid" + }, + { + "description": "static route cidr", + "length": 255, + "name": "cidr", + "required": true, + "type": "string" } ], "related": "listStaticRoutes", "response": [ - { - "description": "the project name of the static route", - "name": "project", - "type": "string" - }, { "description": "the ID of the domain associated with the static route", "name": "domainid", "type": "string" }, - { - "description": "the state of the static route", - "name": "state", - "type": "string" - }, - { - "description": "static route CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the project id of the static route", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the static route", - "name": "account", - "type": "string" - }, { "description": "the domain associated with the static route", "name": "domain", "type": "string" }, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "the account associated with the static route", + "name": "account", "type": "string" }, { - "description": "the ID of static route", - "name": "id", + "description": "the project id of the static route", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "static route CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "the project name of the static route", + "name": "project", "type": "string" }, { @@ -34941,8 +35396,8 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -34951,28 +35406,28 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -34981,19 +35436,40 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "VPC gateway the route is created for", + "name": "gatewayid", + "type": "string" + }, + { + "description": "the state of the static route", + "name": "state", + "type": "string" + }, + {}, + {}, + { + "description": "the ID of static route", + "name": "id", + "type": "string" + } ] }, { @@ -35021,213 +35497,279 @@ "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, - {}, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" + }, + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, + {}, { "description": "name of the availability zone", "name": "zonename", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { "description": "ID of the disk offering", "name": "diskofferingid", "type": "string" }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, { "description": "the disk utilization", "name": "utilization", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "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 display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, + {}, { - "description": "pod name of the volume", - "name": "podname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -35236,28 +35778,23 @@ "type": "string" }, { - "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 project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -35274,39 +35811,14 @@ "type": "set" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { "description": "the ID of the domain associated with the disk volume", @@ -35314,24 +35826,24 @@ "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { "description": "ID of the service offering for root disk", @@ -35339,81 +35851,45 @@ "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "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": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { "description": "the VM's disk read in KiB", "name": "diskkbsread", "type": "long" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - {} + } ], "since": "4.14.0" }, @@ -35423,12 +35899,11 @@ "name": "addTrafficType", "params": [ { - "description": "the Physical Network ID", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, - "type": "uuid" + "name": "xennetworklabel", + "required": false, + "type": "string" }, { "description": "The network name label of the physical device dedicated to this traffic on a VMware host", @@ -35438,76 +35913,72 @@ "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "description": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", "length": 255, - "name": "hypervnetworklabel", + "name": "isolationmethod", "required": false, "type": "string" }, { - "description": "The VLAN id to be used for Management traffic by VMware host", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "vlan", + "name": "hypervnetworklabel", "required": false, "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "the Physical Network ID", "length": 255, - "name": "ovm3networklabel", - "required": false, - "type": "string" + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "the trafficType to be added to the physical network", "length": 255, - "name": "xennetworklabel", - "required": false, + "name": "traffictype", + "required": true, "type": "string" }, { - "description": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "length": 255, - "name": "isolationmethod", + "name": "kvmnetworklabel", "required": false, "type": "string" }, { - "description": "the trafficType to be added to the physical network", + "description": "The VLAN id to be used for Management traffic by VMware host", "length": 255, - "name": "traffictype", - "required": true, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "kvmnetworklabel", + "name": "ovm3networklabel", "required": false, "type": "string" } ], "related": "", "response": [ + {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", + "description": "id of the network provider", + "name": "id", "type": "string" }, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", "type": "string" }, - {}, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -35516,23 +35987,23 @@ "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the trafficType to be added to the physical network", + "name": "traffictype", + "type": "string" }, { - "description": "id of the network provider", - "name": "id", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", "type": "string" }, { @@ -35540,7 +36011,12 @@ "name": "xennetworklabel", "type": "string" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "3.0.0" }, @@ -35559,27 +36035,27 @@ } ], "response": [ - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -35589,11 +36065,12 @@ "name": "listSecondaryStorageSelectors", "params": [ { - "description": "Show removed heuristics.", + "description": "The zone ID to be used in the search filter.", "length": 255, - "name": "showremoved", - "required": false, - "type": "boolean" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "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.", @@ -35605,7 +36082,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -35619,36 +36096,34 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "The zone ID to be used in the search filter.", + "description": "Show removed heuristics.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "showremoved", + "required": false, + "type": "boolean" } ], "related": "createSecondaryStorageSelector,updateSecondaryStorageSelector,removeSecondaryStorageSelector", "response": [ { - "description": "Name of the heuristic.", - "name": "name", + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Name of the heuristic.", + "name": "name", + "type": "string" }, - {}, { - "description": "When the heuristic was removed.", - "name": "removed", + "description": "When the heuristic was created.", + "name": "created", "type": "date" }, { @@ -35657,34 +36132,35 @@ "type": "string" }, { - "description": "ID of the heuristic.", - "name": "id", + "description": "Description of the heuristic.", + "name": "description", "type": "string" }, + {}, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", "type": "string" }, { - "description": "Description of the heuristic.", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "ID of the heuristic.", + "name": "id", "type": "string" }, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", - "type": "string" + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", + "type": "string" } ], "since": "4.19.0" @@ -35694,20 +36170,6 @@ "isasync": false, "name": "listLoadBalancerRuleInstances", "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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -35719,10 +36181,24 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" }, + { + "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": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "true if load balancer rule VM IP information to be included; default is false", "length": 255, @@ -35733,7 +36209,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -35742,20 +36218,20 @@ "response": [ {}, { - "description": "the user vm set for lb rule", - "name": "loadbalancerruleinstance", - "type": "uservmresponse" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "IP addresses of the vm set of lb rule", "name": "lbvmipaddresses", "type": "list" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user vm set for lb rule", + "name": "loadbalancerruleinstance", + "type": "uservmresponse" }, { "description": "the UUID of the latest async job acting on this object", @@ -35779,6 +36255,11 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -35790,17 +36271,12 @@ "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + {} ] }, { @@ -35808,6 +36284,14 @@ "isasync": false, "name": "updateDomain", "params": [ + { + "description": "ID of domain to update", + "length": 255, + "name": "id", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": true, + "type": "uuid" + }, { "description": "updates domain with this name", "length": 255, @@ -35821,91 +36305,90 @@ "name": "networkdomain", "required": false, "type": "string" - }, - { - "description": "ID of domain to update", - "length": 255, - "name": "id", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, - "type": "uuid" } ], "related": "createDomain,listDomainChildren,listDomains,listDomains", "response": [ { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the name of the domain", + "name": "name", + "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, + {}, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { @@ -35914,38 +36397,33 @@ "type": "integer" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "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", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", - "type": "string" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { @@ -35954,106 +36432,114 @@ "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" }, - {}, { "description": "whether the domain has one or more sub-domains", "name": "haschild", "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, - {}, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "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": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the ID of the domain", + "name": "id", "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 owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the name of the domain", - "name": "name", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { "description": "the total number of templates which can be created by this domain", @@ -36061,33 +36547,23 @@ "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" } ] @@ -36098,19 +36574,27 @@ "name": "updatePhysicalNetwork", "params": [ { - "description": "the speed for the physical network[1G/10G]", + "description": "Enabled/Disabled", "length": 255, - "name": "networkspeed", + "name": "state", "required": false, "type": "string" }, { - "description": "Enabled/Disabled", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "state", + "name": "networkspeed", "required": false, "type": "string" }, + { + "description": "physical network id", + "length": 255, + "name": "id", + "related": "createPhysicalNetwork,updatePhysicalNetwork", + "required": true, + "type": "uuid" + }, { "description": "Tag the physical network", "length": 255, @@ -36124,85 +36608,77 @@ "name": "vlan", "required": false, "type": "string" - }, - { - "description": "physical network id", - "length": 255, - "name": "id", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, - "type": "uuid" } ], "related": "createPhysicalNetwork", "response": [ { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "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": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, + {}, { "description": "zone id of the physical network", "name": "zoneid", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "state of the physical network", + "name": "state", "type": "string" }, + {}, { "description": "name of the physical network", "name": "name", "type": "string" }, - {}, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { - "description": "comma separated tag", - "name": "tags", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id of the physical 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 uuid of the physical network", "name": "id", "type": "string" }, { - "description": "state of the physical network", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -36223,85 +36699,79 @@ "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", + "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the public port", + "name": "publicport", + "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the domain name of the vm group", + "name": "domain", + "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the current state of the AutoScale Vm Group", + "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": "the name of the autoscale vm group ", + "name": "name", + "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" - }, - {}, - { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "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.", @@ -36309,61 +36779,67 @@ "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 autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, + {}, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, - {}, { - "description": "the project name of the vm group", - "name": "project", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" - } + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" + }, + { + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + }, + {} ] }, { @@ -36371,6 +36847,13 @@ "isasync": false, "name": "createSnapshotPolicy", "params": [ + { + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "length": 255, + "name": "intervaltype", + "required": true, + "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, @@ -36379,11 +36862,19 @@ "type": "string" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "description": "the ID of the disk volume", "length": 255, - "name": "intervaltype", + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, - "type": "string" + "type": "uuid" + }, + { + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { "description": "an optional field, whether to the display the policy to the end user or not", @@ -36393,14 +36884,6 @@ "since": "4.4", "type": "boolean" }, - { - "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", - "required": true, - "type": "uuid" - }, { "description": "A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present.", "length": 255, @@ -36410,11 +36893,11 @@ "type": "list" }, { - "description": "Map of tags (key/value pairs)", + "description": "maximum number of snapshots to retain", "length": 255, - "name": "tags", - "required": false, - "type": "map" + "name": "maxsnaps", + "required": true, + "type": "integer" }, { "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", @@ -36422,131 +36905,124 @@ "name": "timezone", "required": true, "type": "string" - }, - { - "description": "maximum number of snapshots to retain", - "length": 255, - "name": "maxsnaps", - "required": true, - "type": "integer" } ], "related": "updateSnapshotPolicy", "response": [ - { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" - }, - { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" - }, - {}, - { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" - }, - { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the snapshot policy", - "name": "id", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the list of resource tags associated", "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, + { + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" + }, { "description": "maximum number of snapshots retained", "name": "maxsnaps", "type": "int" }, - {} + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, + { + "description": "the ID of the snapshot policy", + "name": "id", + "type": "string" + }, + {}, + { + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" + }, + { + "description": "the current status of the latest async job acting 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 interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, + { + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" + } ] }, { @@ -36564,6 +37040,17 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -36574,18 +37061,7 @@ "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" - } + {} ] }, { @@ -36603,28 +37079,28 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "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.11" }, @@ -36633,13 +37109,6 @@ "isasync": false, "name": "listTungstenFabricFirewallRule", "params": [ - { - "description": "the uuid of Tungsten-Fabric firewall rule", - "length": 255, - "name": "firewallruleuuid", - "required": false, - "type": "string" - }, { "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, @@ -36647,13 +37116,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -36675,50 +37137,37 @@ "name": "page", "required": false, "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", - "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": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", - "type": "string" - }, - {}, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", + "description": "the uuid of Tungsten-Fabric firewall rule", + "length": 255, + "name": "firewallruleuuid", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", "type": "string" }, { @@ -36727,28 +37176,29 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source tag", - "name": "srctag", + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "type": "string" }, { @@ -36757,67 +37207,24 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - } - ] - }, - { - "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 description of the role permission", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, - { - "description": "ID of the role", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, - "type": "uuid" - }, - { - "description": "The API name or wildcard rule such as list*", - "length": 255, - "name": "rule", - "required": true, - "type": "string" - } - ], - "related": "listRolePermissions", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" }, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", "type": "string" }, + {}, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, { - "description": "the ID of the role permission", - "name": "id", + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", "type": "string" }, { @@ -36826,24 +37233,11 @@ "type": "integer" }, { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", - "type": "string" - }, - {}, - { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" - }, - { - "description": "the description of the role permission", - "name": "description", + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", "type": "string" - }, - {} - ], - "since": "4.9.0" + } + ] }, { "description": "List system virtual machines.", @@ -36851,91 +37245,106 @@ "name": "listSystemVms", "params": [ { - "description": "the state of the system VM", + "description": "the Zone ID of the system VM", "length": 255, - "name": "state", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "keyword", + "name": "systemvmtype", "required": false, "type": "string" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "the Pod ID of the system VM", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "since": "3.0.1", "type": "uuid" }, { - "description": "the Zone ID of the system VM", + "description": "the name of the system VM", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the system VM", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, + "since": "3.0.1", "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the Pod ID of the system VM", + "description": "the host ID of the system VM", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, "type": "uuid" }, { - "description": "the name of the system VM", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", + "description": "the ID of the system VM", "length": 255, - "name": "systemvmtype", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the state of the system VM", "length": 255, - "name": "pagesize", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the host ID of the system VM", + "description": "", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ + { + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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 state of the system VM", "name": "state", @@ -36947,38 +37356,48 @@ "type": "list" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" + }, + { + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { @@ -36987,109 +37406,120 @@ "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the host ID for the system VM", + "name": "hostid", "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 public IP address for the system VM", - "name": "publicip", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "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", + "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "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": "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 second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { @@ -37098,57 +37528,103 @@ "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" + } + ] + }, + { + "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 Zone ID for the system VM", - "name": "zoneid", + "description": "The API name or wildcard rule such as list*", + "length": 255, + "name": "rule", + "required": true, + "type": "string" + }, + { + "description": "ID of the role", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": true, + "type": "uuid" + }, + { + "description": "The description of the role permission", + "length": 255, + "name": "description", + "required": false, + "type": "string" + } + ], + "related": "listRolePermissions", + "response": [ + { + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, {}, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the ID of the role permission", + "name": "id", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the current status of the latest async job acting 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 control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", + "type": "string" } - ] + ], + "since": "4.9.0" }, { "description": "Creates a project", @@ -37164,12 +37640,20 @@ "type": "uuid" }, { - "description": "account who will be Admin for the project", + "description": "The display text of the project, defaults to the 'name´.", "length": 255, - "name": "account", + "name": "displaytext", "required": false, "type": "string" }, + { + "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": "name of the project", "length": 255, @@ -37178,9 +37662,9 @@ "type": "string" }, { - "description": "The display text of the project, defaults to the 'name´.", + "description": "account who will be Admin for the project", "length": 255, - "name": "displaytext", + "name": "account", "required": false, "type": "string" }, @@ -37192,37 +37676,24 @@ "required": false, "since": "4.15.0", "type": "uuid" - }, - { - "description": "ID of the account owning a project", - "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" } ], "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "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 project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { "description": "the id of the project", @@ -37230,44 +37701,45 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, + {}, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total 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 account name of the project's owners", @@ -37275,73 +37747,58 @@ "type": "list" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" - }, - {}, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the name of the project", - "name": "name", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, + {}, { "description": "the 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": "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", "type": "string" }, { @@ -37354,29 +37811,24 @@ "name": "project", "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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -37388,70 +37840,69 @@ "type": "list" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" }, - {}, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" }, { "description": "the total number of virtual machines deployed by this project", @@ -37459,44 +37910,69 @@ "type": "long" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" } ], "since": "3.0.0" @@ -37507,18 +37983,18 @@ "name": "assignCertToLoadBalancer", "params": [ { - "description": "the ID of the load balancer rule", + "description": "the ID of the certificate", "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "certid", + "related": "uploadSslCert", "required": true, "type": "uuid" }, { - "description": "the ID of the certificate", + "description": "the ID of the load balancer rule", "length": 255, - "name": "certid", - "related": "uploadSslCert", + "name": "lbruleid", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" } @@ -37526,9 +38002,9 @@ "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", @@ -37537,9 +38013,9 @@ }, {}, { - "description": "the current status of the latest async job acting 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", @@ -37561,12 +38037,11 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { "description": "Hostname or ip address of the Cisco VNMC Controller.", @@ -37576,24 +38051,23 @@ "type": "string" }, { - "description": "Credentials to access the Cisco VNMC Controller API", + "description": "the Physical Network ID", "length": 255, - "name": "password", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listCiscoVnmcResources", "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - {}, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -37601,6 +38075,8 @@ }, {}, {}, + {}, + {}, {} ] }, @@ -37617,13 +38093,6 @@ "required": false, "type": "uuid" }, - { - "description": "the device ID on the virtual machine where volume is detached from", - "length": 255, - "name": "deviceid", - "required": false, - "type": "long" - }, { "description": "the ID of the disk volume", "length": 255, @@ -37631,133 +38100,223 @@ "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "type": "uuid" + }, + { + "description": "the device ID on the virtual machine where volume is detached from", + "length": 255, + "name": "deviceid", + "required": false, + "type": "long" } ], "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, + {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "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": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "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": "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": "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 account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "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", + "type": "string" + }, { "description": "pod id of the volume", "name": "podid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -37766,124 +38325,98 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "size of the disk volume", + "name": "size", "type": "long" }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" - }, { "description": "the VM's disk read in KiB", "name": "diskkbsread", "type": "long" }, { - "description": "size of the disk volume", - "name": "size", + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "description": "cluster id of the volume", + "name": "clusterid", "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": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "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": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { @@ -37892,8 +38425,8 @@ "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { @@ -37902,24 +38435,29 @@ "type": "boolean" }, { - "description": "the status of the volume", - "name": "status", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "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", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { @@ -37928,105 +38466,43 @@ "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "the date the disk volume was created", - "name": "created", + "description": "the date the volume was attached to a VM instance", + "name": "attached", "type": "date" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, { "description": "id of the primary storage hosting the disk volume; returned to admin user only", "name": "storageid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" } ] @@ -38067,18 +38543,18 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -38091,13 +38567,6 @@ "isasync": false, "name": "listTungstenFabricAddressGroup", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the uuid of Tungsten-Fabric address group", "length": 255, @@ -38106,12 +38575,11 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -38121,57 +38589,65 @@ "type": "integer" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "createTungstenFabricAddressGroup", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Tungsten-Fabric address group ip prefix length", "name": "ipprefixlen", "type": "int" }, + { + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", + "type": "string" + }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + {}, { - "description": "Tungsten-Fabric address group uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric address group name", - "name": "name", + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", + "description": "Tungsten-Fabric address group name", + "name": "name", "type": "string" - } + }, + {} ] }, { @@ -38207,83 +38683,53 @@ "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", "response": [ { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "the name of the account", - "name": "name", - "type": "string" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "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 number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { @@ -38291,53 +38737,48 @@ "name": "user", "response": [ { - "description": "the user lastname", - "name": "lastname", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user firstname", - "name": "firstname", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "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 name of the user", + "name": "account", + "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 email address", - "name": "email", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the user state", - "name": "state", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -38346,81 +38787,86 @@ "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "true if user is default, false otherwise", "name": "isdefault", "type": "boolean" }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, { "description": "true if user has two factor authentication is mandated", "name": "is2famandated", "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "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 source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user ID", + "name": "id", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "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 name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" } ], "type": "list" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { @@ -38429,35 +38875,29 @@ "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", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the id of the account", + "name": "id", "type": "string" }, - {}, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { "description": "the total secondary storage space (in GiB) available to be used for this account", @@ -38465,33 +38905,33 @@ "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the name of the account", + "name": "name", + "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { @@ -38500,13 +38940,33 @@ "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { @@ -38515,125 +38975,141 @@ "type": "integer" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, - {}, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "details for the account", "name": "accountdetails", "type": "map" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, + {}, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" } ], "since": "4.0" @@ -38655,30 +39131,25 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,issueOutOfBandManagementPowerAction", "response": [ { - "description": "the operation result description", - "name": "description", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the out-of-band management interface port", - "name": "port", + "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 out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { "description": "the out-of-band management interface address", @@ -38686,36 +39157,41 @@ "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, {}, + { + "description": "the operation result description", + "name": "description", + "type": "string" + }, { "description": "the operation result", "name": "status", @@ -38729,6 +39205,14 @@ "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, @@ -38751,36 +39235,32 @@ "required": false, "type": "string" }, - { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], "related": "", "response": [ - {}, { - "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 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", @@ -38788,41 +39268,37 @@ "type": "string" }, { - "description": "The user's domain", - "name": "domain", + "description": "The user's username", + "name": "username", "type": "string" }, - {}, { - "description": "The user's email", - "name": "email", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The user's username", - "name": "username", + "description": "The user's domain", + "name": "domain", "type": "string" }, { - "description": "The user's lastname", - "name": "lastname", + "description": "The user's email", + "name": "email", "type": "string" }, + {}, { "description": "The user's principle", "name": "principal", "type": "string" }, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, - { - "description": "The user's firstname", - "name": "firstname", - "type": "string" - } + {} ], "since": "4.2.0" }, @@ -38831,13 +39307,6 @@ "isasync": true, "name": "revokeCertificate", "params": [ - { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, { "description": "The certificate CN", "length": 255, @@ -38851,31 +39320,38 @@ "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" } ], "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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.11.0" }, @@ -38884,14 +39360,6 @@ "isasync": false, "name": "changeServiceForSystemVm", "params": [ - { - "description": "the service offering ID to apply to the system vm", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, { "description": "The ID of the system vm", "length": 255, @@ -38906,74 +39374,81 @@ "name": "details", "required": false, "type": "map" + }, + { + "description": "the service offering ID to apply to the system vm", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" } ], "related": "migrateSystemVm,startSystemVm", "response": [ { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", - "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { @@ -38982,8 +39457,8 @@ "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { @@ -38992,38 +39467,38 @@ "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { @@ -39032,94 +39507,95 @@ "type": "integer" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, - {}, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "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 number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" } ] @@ -39130,19 +39606,19 @@ "name": "updateSiocInfo", "params": [ { - "description": "Storage Pool ID", + "description": "Notify if IOPS above this value", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "iopsnotifythreshold", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "Shares per GB", + "description": "Storage Pool ID", "length": 255, - "name": "sharespergb", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": true, - "type": "integer" + "type": "uuid" }, { "description": "Zone ID", @@ -39153,9 +39629,9 @@ "type": "uuid" }, { - "description": "Notify if IOPS above this value", + "description": "Shares per GB", "length": 255, - "name": "iopsnotifythreshold", + "name": "sharespergb", "required": true, "type": "integer" }, @@ -39169,7 +39645,6 @@ ], "related": "", "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -39177,15 +39652,16 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The return message from the operation ('Success' if successful)", + "name": "msg", "type": "string" }, { - "description": "The return message from the operation ('Success' if successful)", - "name": "msg", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.11.0" }, @@ -39194,6 +39670,13 @@ "isasync": false, "name": "createVMSchedule", "params": [ + { + "description": "Description of the schedule", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, { "description": "ID of the VM for which schedule is to be defined", "length": 255, @@ -39202,13 +39685,6 @@ "required": true, "type": "uuid" }, - { - "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", - "length": 255, - "name": "schedule", - "required": true, - "type": "string" - }, { "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, @@ -39216,13 +39692,6 @@ "required": false, "type": "date" }, - { - "description": "Action to take on the VM (start/stop/restart/force_stop/force_reboot).", - "length": 255, - "name": "action", - "required": true, - "type": "string" - }, { "description": "start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, @@ -39230,6 +39699,13 @@ "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'", + "length": 255, + "name": "schedule", + "required": true, + "type": "string" + }, { "description": "Enable VM schedule. Defaults to true", "length": 255, @@ -39238,83 +39714,83 @@ "type": "boolean" }, { - "description": "Description of the schedule", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, - "name": "description", - "required": false, + "name": "timezone", + "required": true, "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "description": "Action to take on the VM (start/stop/restart/force_stop/force_reboot).", "length": 255, - "name": "timezone", + "name": "action", "required": true, "type": "string" } ], "related": "updateVMSchedule", "response": [ + { + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" + }, { "description": "ID of virtual machine", "name": "virtualmachineid", "type": "string" }, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "Description of VM schedule", + "name": "description", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" - }, + {}, { "description": "Date when the schedule was created", "name": "created", "type": "date" }, { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" + "description": "Timezone of the schedule", + "name": "timezone", + "type": "string" + }, + { + "description": "the ID of VM schedule", + "name": "id", + "type": "string" }, - {}, - {}, { "description": "Action", "name": "action", "type": "action" }, + {}, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", + "description": "Date from which the schedule is active", + "name": "startdate", "type": "date" }, { - "description": "the ID of VM schedule", - "name": "id", - "type": "string" - }, - { - "description": "Description of VM schedule", - "name": "description", - "type": "string" + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" }, { - "description": "Timezone of the schedule", - "name": "timezone", + "description": "Cron formatted VM schedule", + "name": "schedule", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.19.0" @@ -39325,26 +39801,19 @@ "name": "listIpForwardingRules", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "list the rule belonging to this public IP address", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "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.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "List by keyword", @@ -39354,69 +39823,72 @@ "type": "string" }, { - "description": "Lists all rules applied to the specified VM.", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "list the rule belonging to this public IP address", "length": 255, - "name": "page", + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Lists all rules applied to the specified VM.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, "type": "uuid" }, { - "description": "Lists rule with the specified ID.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "isrecursive", "required": false, - "type": "uuid" + "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", + "name": "account", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", "response": [ + {}, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { @@ -39424,63 +39896,28 @@ "name": "state", "type": "string" }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the 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 protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -39489,62 +39926,82 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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" }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, { "description": "the starting port of port forwarding rule's public port range", "name": "publicport", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, { "description": "the public ip address id for the port forwarding rule", "name": "ipaddressid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "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 starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { @@ -39552,10 +40009,29 @@ "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" } ] @@ -39566,25 +40042,18 @@ "name": "createSnapshot", "params": [ { - "description": "asynchronous backup if true", + "description": "quiesce vm if true", "length": 255, - "name": "asyncbackup", + "name": "quiescevm", "required": false, "type": "boolean" }, { - "description": "Map of tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", + "description": "The ID of the disk volume", "length": 255, - "name": "policyid", - "related": "updateSnapshotPolicy", - "required": false, + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, "type": "uuid" }, { @@ -39594,13 +40063,6 @@ "required": false, "type": "string" }, - { - "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", - "length": 255, - "name": "locationtype", - "required": false, - "type": "string" - }, { "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain.", "length": 255, @@ -39610,11 +40072,18 @@ "type": "uuid" }, { - "description": "the name of the snapshot", + "description": "Map of tags (key/value pairs)", "length": 255, - "name": "name", + "name": "tags", "required": false, - "type": "string" + "type": "map" + }, + { + "description": "asynchronous backup if true", + "length": 255, + "name": "asyncbackup", + "required": false, + "type": "boolean" }, { "description": "A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", @@ -39626,125 +40095,152 @@ "type": "list" }, { - "description": "quiesce vm if true", + "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", "length": 255, - "name": "quiescevm", + "name": "policyid", + "related": "updateSnapshotPolicy", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "The ID of the disk volume", + "description": "the name of the snapshot", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", + "length": 255, + "name": "locationtype", + "required": false, + "type": "string" } ], "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", "response": [ { - "description": "ID of the snapshot", - "name": "id", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, + {}, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the snapshot", + "name": "project", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "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": "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the 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 domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, - {}, - { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" - }, { "description": "physical size of backedup snapshot on image store", "name": "physicalsize", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { "description": "the type of the snapshot", @@ -39752,110 +40248,90 @@ "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, + {}, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "the status of the template", - "name": "status", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "type of the disk volume", - "name": "volumetype", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - {}, - { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, - { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, { "description": "name of the snapshot", "name": "name", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" } ] }, @@ -39874,28 +40350,28 @@ } ], "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } + }, + {} ], "since": "4.2.0" }, @@ -39905,27 +40381,26 @@ "name": "listStoragePoolsMetrics", "params": [ { - "description": "list storage pools belongig to the specific cluster", + "description": "the scope of the storage pool", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Zone ID for the storage pool", + "description": "the status of the storage pool", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "status", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "the ID of the storage pool", @@ -39936,41 +40411,49 @@ "type": "uuid" }, { - "description": "the IP address for the storage pool", + "description": "List by keyword", "length": 255, - "name": "ipaddress", + "name": "keyword", "required": false, "type": "string" }, { - "description": "host ID of the storage pools", + "description": "the storage pool path", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "path", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the status of the storage pool", + "description": "the name of the storage pool", "length": 255, - "name": "status", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "host ID of the storage pools", "length": 255, - "name": "pagesize", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the storage pool path", + "description": "the IP address for the storage pool", "length": 255, - "name": "path", + "name": "ipaddress", "required": false, "type": "string" }, + { + "description": "list storage pools belongig to the specific cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, { "description": "the Pod ID for the storage pool", "length": 255, @@ -39980,26 +40463,19 @@ "type": "uuid" }, { - "description": "", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the scope of the storage pool", + "description": "", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "string" - }, - { - "description": "the name of the storage pool", - "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", @@ -40010,115 +40486,105 @@ "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "disk size unallocated in GiB", + "name": "disksizeunallocatedgb", "type": "string" }, { - "description": "disk size allocated in GiB", - "name": "disksizeallocatedgb", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" - }, - {}, - { - "description": "the name of the storage pool", - "name": "name", + "description": "disk size in GiB", + "name": "disksizetotalgb", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the storage pool type", + "name": "type", "type": "string" }, - { - "description": "storage usage disable threshold exceeded", - "name": "storageusagedisablethreshold", - "type": "boolean" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, { "description": "the ID of the storage pool", "name": "id", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, + { + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, { "description": "the total disk size of the storage pool", "name": "disksizetotal", "type": "long" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "disk size used in GiB", + "name": "disksizeusedgb", + "type": "string" }, { - "description": "disk size in GiB", - "name": "disksizetotalgb", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "disk size used in GiB", - "name": "disksizeusedgb", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "storage usage disable threshold exceeded", + "name": "storageusagedisablethreshold", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { "description": "Storage provider for this pool", @@ -40126,23 +40592,33 @@ "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "storage allocated notification threshold exceeded", - "name": "storageallocatedthreshold", - "type": "boolean" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "disk size unallocated in GiB", - "name": "disksizeunallocatedgb", + "description": "disk size allocated in GiB", + "name": "disksizeallocatedgb", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { @@ -40150,46 +40626,46 @@ "name": "storageusagethreshold", "type": "boolean" }, + {}, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, { "description": "storage allocated disable threshold exceeded", "name": "storageallocateddisablethreshold", "type": "boolean" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, - {}, { "description": "the Zone ID of the storage pool", "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "storage allocated notification threshold exceeded", + "name": "storageallocatedthreshold", "type": "boolean" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" } ], "since": "4.9.3" @@ -40210,27 +40686,27 @@ ], "related": "", "response": [ + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "result of the unmanage VM operation", + "name": "success", + "type": "boolean" }, - {}, { "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "result of the unmanage VM operation", - "name": "success", - "type": "boolean" + "description": "details of the unmanage VM operation", + "name": "details", + "type": "string" } ], "since": "4.15.0" @@ -40240,14 +40716,6 @@ "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, @@ -40255,33 +40723,36 @@ "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "required": true, "type": "uuid" + }, + { + "description": "Force reboot the router (Router is force Stopped and then Started)", + "length": 255, + "name": "forced", + "required": false, + "since": "4.16.0", + "type": "boolean" } ], "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the name of the router", - "name": "name", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { @@ -40289,26 +40760,66 @@ "name": "vpcid", "type": "string" }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, { "description": "the version of template", "name": "version", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", "type": "string" }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the list of nics associated with the router", "name": "nic", @@ -40319,53 +40830,43 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -40373,84 +40874,74 @@ "name": "ipaddresses", "type": "list" }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, { "description": "the broadcast uri of the nic", "name": "broadcasturi", "type": "string" }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, { "description": "true if nic is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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 gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -40458,43 +40949,47 @@ "name": "isolationuri", "type": "string" }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, { "description": "the extra dhcp options on the nic", "name": "extradhcpoption", "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" } ], "type": "set" }, - {}, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { @@ -40503,54 +40998,34 @@ "type": "state" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, {}, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the name of the router", + "name": "name", "type": "string" }, { @@ -40559,103 +41034,94 @@ "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, + {}, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the network domain for the router", + "name": "networkdomain", "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": "the domain associated with the router", - "name": "domain", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { @@ -40664,29 +41130,29 @@ "type": "boolean" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "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 date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, { "description": "the type of the health check - basic or advanced", "name": "checktype", "type": "string" }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, { "description": "detailed response generated on running health check", "name": "details", @@ -40696,29 +41162,39 @@ "description": "the name of the health check on the router", "name": "checkname", "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" } ], "type": "list" }, { - "description": "the project name of the address", - "name": "project", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" } ] }, @@ -40727,6 +41203,21 @@ "isasync": false, "name": "listNics", "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "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 nic to list IPs", "length": 255, @@ -40736,11 +41227,11 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of the vm", @@ -40750,18 +41241,10 @@ "required": true, "type": "uuid" }, - { - "description": "list nic of the specific vm's network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -40772,81 +41255,79 @@ "required": false, "since": "4.4", "type": "boolean" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "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 name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, + {}, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the traffic type of the nic", + "name": "traffictype", "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -40855,55 +41336,50 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, - {}, { "description": "the gateway of the nic", "name": "gateway", "type": "string" }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, { "description": "the broadcast uri of the nic", "name": "broadcasturi", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "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 ID of the nic", + "name": "id", "type": "string" }, + {}, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { "description": "the isolated private VLAN type if available", @@ -40911,44 +41387,44 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" } ] }, @@ -40964,13 +41440,6 @@ "required": true, "type": "string" }, - { - "description": "an optional account for the ssh key. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "an optional project for the ssh key", "length": 255, @@ -40986,6 +41455,13 @@ "related": "createDomain,listDomainChildren,listDomains,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": "", @@ -40995,25 +41471,15 @@ "name": "hasannotations", "type": "boolean" }, - {}, - { - "description": "the domain id of the keypair owner", - "name": "domainid", - "type": "string" - }, - { - "description": "Private key", - "name": "privatekey", - "type": "string" - }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { @@ -41027,29 +41493,39 @@ "type": "string" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, + {}, { - "description": "the owner of the keypair", - "name": "account", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, - {}, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "Private key", + "name": "privatekey", "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the owner of the keypair", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the keypair owner", + "name": "projectid", + "type": "string" + }, + { + "description": "ID of the ssh keypair", + "name": "id", "type": "string" } ] @@ -41067,13 +41543,6 @@ "required": true, "type": "uuid" }, - { - "description": "the name of the snapshot", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "The ID of the VM snapshot", "length": 255, @@ -41081,125 +41550,158 @@ "related": "listVMSnapshot,createVMSnapshot", "required": true, "type": "uuid" + }, + { + "description": "the name of the snapshot", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", "response": [ - { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" - }, { "description": "ID of the disk volume", "name": "volumeid", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "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": "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": "type of the disk volume", "name": "volumetype", "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "name of the snapshot", + "name": "name", + "type": "string" + }, { "description": "id of the availability zone", "name": "zoneid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, - {}, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "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": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", + "type": "string" + }, + {}, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { "description": "the list of resource tags associated", @@ -41211,28 +41713,28 @@ "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", - "type": "string" + "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": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -41241,63 +41743,37 @@ "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" - }, - { - "description": "name of the snapshot", - "name": "name", - "type": "string" - }, - {}, - { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" - }, - { - "description": "the 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": "name of the availability zone", - "name": "zonename", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "ID of the snapshot", - "name": "id", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" } ], "since": "4.10.0" @@ -41308,25 +41784,26 @@ "name": "listTungstenFabricServiceGroup", "params": [ { - "description": "the uuid of Tungsten-Fabric service group", + "description": "List by keyword", "length": 255, - "name": "servicegroupuuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric service group", "length": 255, - "name": "pagesize", + "name": "servicegroupuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "the ID of zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -41336,34 +41813,24 @@ "type": "integer" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createTungstenFabricServiceGroup", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric service group start port", - "name": "startport", - "type": "int" - }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + {}, { - "description": "Tungsten-Fabric service group protocol", - "name": "protocol", + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", "type": "string" }, { @@ -41372,22 +41839,31 @@ "type": "int" }, { - "description": "Tungsten-Fabric service group name", - "name": "name", + "description": "Tungsten-Fabric service group protocol", + "name": "protocol", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric service group name", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric service group uuid", - "name": "uuid", + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", @@ -41401,11 +41877,11 @@ "name": "authorizeSecurityGroupEgress", "params": [ { - "description": "user to security group mapping", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "usersecuritygrouplist", + "name": "securitygroupname", "required": false, - "type": "map" + "type": "string" }, { "description": "an optional account for the security group. Must be used with domainId.", @@ -41415,18 +41891,26 @@ "type": "string" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "description": "start port for this egress rule", "length": 255, - "name": "cidrlist", + "name": "startport", "required": false, - "type": "list" + "type": "integer" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "user to security group mapping", "length": 255, - "name": "securitygroupname", + "name": "usersecuritygrouplist", "required": false, - "type": "string" + "type": "map" + }, + { + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { "description": "TCP is default. UDP is the other supported protocol", @@ -41436,26 +41920,24 @@ "type": "string" }, { - "description": "an optional project of the security group", + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "cidrlist", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "end port for this egress rule", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "endport", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "an optional project of the security group", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -41466,13 +41948,6 @@ "required": false, "type": "integer" }, - { - "description": "start port for this egress rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" - }, { "description": "type of the icmp message being sent", "length": 255, @@ -41481,61 +41956,40 @@ "type": "integer" }, { - "description": "end port for this egress rule", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "endport", + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "authorizeSecurityGroupIngress", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, - {}, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the 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 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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the protocol of the security group rule", @@ -41543,27 +41997,28 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, + {}, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -41572,37 +42027,58 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + {}, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], "since": "3.0.0" @@ -41613,9 +42089,18 @@ "name": "listStoragePools", "params": [ { - "description": "the IP address for the storage pool", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "ipaddress", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the scope of the storage pool", + "length": 255, + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" }, @@ -41628,25 +42113,32 @@ "type": "uuid" }, { - "description": "list storage pools belongig to the specific cluster", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "the status of the storage pool", "length": 255, - "name": "pagesize", + "name": "status", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "list storage pools belongig to the specific cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { "description": "host ID of the storage pools", "length": 255, "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, "type": "uuid" }, @@ -41666,81 +42158,70 @@ "type": "uuid" }, { - "description": "the storage pool path", + "description": "List by keyword", "length": 255, - "name": "path", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the scope of the storage pool", + "description": "the storage pool path", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "path", "required": false, "type": "string" }, { - "description": "the Zone ID for the storage pool", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "the IP address for the storage pool", "length": 255, - "name": "keyword", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "the status of the storage pool", + "description": "", "length": 255, - "name": "status", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { "description": "the date and time the storage pool was created", @@ -41748,44 +42229,33 @@ "type": "date" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - {}, - { - "description": "the storage pool type", - "name": "type", - "type": "string" - }, - { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -41794,69 +42264,75 @@ "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, + { + "description": "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": "true if this pool is suitable to migrate a volume, false otherwise", "name": "suitableformigration", "type": "boolean" }, - {}, { - "description": "the storage pool path", - "name": "path", + "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": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the storage pool type", + "name": "type", "type": "string" }, + {}, { - "description": "the name of the storage pool", - "name": "name", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" } ] @@ -41866,20 +42342,6 @@ "isasync": false, "name": "listImageStoreObjects", "params": [ - { - "description": "path to list on image store", - "length": 255, - "name": "path", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "id of the image store", "length": 255, @@ -41895,6 +42357,20 @@ "required": false, "type": "string" }, + { + "description": "path to list on image store", + "length": 255, + "name": "path", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -41906,55 +42382,55 @@ "related": "", "response": [ { - "description": "Template ID associated with the data store object.", - "name": "templateid", - "type": "string" + "description": "Size is in Bytes.", + "name": "size", + "type": "long" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", + "type": "string" }, { "description": "Volume ID associated with the data store object.", "name": "volumeid", "type": "string" }, - { - "description": "Name of the data store object.", - "name": "name", - "type": "string" - }, { "description": "Last modified date of the file/directory.", "name": "lastupdated", "type": "date" }, { - "description": "Is it a directory.", - "name": "isdirectory", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Size is in Bytes.", - "name": "size", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, - {}, { "description": "Format of template associated with the data store object.", "name": "format", "type": "string" }, { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" + }, + { + "description": "Name of the data store object.", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Template ID associated with the data store object.", + "name": "templateid", "type": "string" } ], @@ -41965,13 +42441,6 @@ "isasync": false, "name": "updateHypervisorCapabilities", "params": [ - { - "description": "the max number of Guest VMs per host for this hypervisor.", - "length": 255, - "name": "maxguestslimit", - "required": false, - "type": "long" - }, { "description": "the maximum number of the hypervisor hosts per cluster ", "length": 255, @@ -41988,6 +42457,13 @@ "since": "4.16.0", "type": "boolean" }, + { + "description": "set true to enable security group for this hypervisor.", + "length": 255, + "name": "securitygroupenabled", + "required": false, + "type": "boolean" + }, { "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", "length": 255, @@ -41997,19 +42473,19 @@ "type": "integer" }, { - "description": "ID of the hypervisor capability", + "description": "the max number of Guest VMs per host for this hypervisor.", "length": 255, - "name": "id", - "related": "listHypervisorCapabilities,updateHypervisorCapabilities", + "name": "maxguestslimit", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "set true to enable security group for this hypervisor.", + "description": "ID of the hypervisor capability", "length": 255, - "name": "securitygroupenabled", + "name": "id", + "related": "listHypervisorCapabilities,updateHypervisorCapabilities", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "set true to enable VM snapshots for this hypervisor", @@ -42023,9 +42499,14 @@ "related": "listHypervisorCapabilities", "response": [ { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" + }, + { + "description": "true if security group is supported", + "name": "securitygroupenabled", + "type": "boolean" }, { "description": "the maximum number of Data Volumes that can be attached for this hypervisor", @@ -42034,8 +42515,8 @@ }, {}, { - "description": "the ID of the hypervisor capabilities row", - "name": "id", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { @@ -42043,30 +42524,20 @@ "name": "hypervisor", "type": "string" }, - { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", - "type": "boolean" - }, {}, - { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if security group is supported", - "name": "securitygroupenabled", + "description": "true if storage motion is supported", + "name": "storagemotionenabled", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", "type": "integer" }, { @@ -42075,9 +42546,14 @@ "type": "long" }, { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" + }, + { + "description": "the ID of the hypervisor capabilities row", + "name": "id", + "type": "string" } ], "since": "3.0.0" @@ -42097,7 +42573,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -42112,7 +42588,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -42120,59 +42596,93 @@ "related": "", "response": [ { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the IP address of the host", + "name": "ipaddress", + "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 Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, { "description": "the amount of the host's memory currently allocated in bytes", "name": "memoryallocatedbytes", "type": "long" }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, { "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", "name": "memorytotal", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { @@ -42181,53 +42691,48 @@ "type": "long" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "long" - }, { "description": "comma-separated list of tags for the host", "name": "hosttags", "type": "string" }, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, { "description": "the OS category ID of the host", "name": "oscategoryid", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { @@ -42235,19 +42740,15 @@ "name": "hypervisorversion", "type": "string" }, + {}, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "true if migrating a vm to this host requires storage motion, false otherwise", - "name": "requiresStorageMotion", - "type": "boolean" - }, - { - "description": "the name of the host", - "name": "name", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ", + "name": "memorywithoverprovisioning", "type": "string" }, { @@ -42256,44 +42757,43 @@ "type": "date" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, - {}, { "description": "the resource state of the host", "name": "resourcestate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { @@ -42302,84 +42802,60 @@ "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" - }, - { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "true if migrating a vm to this host requires storage motion, false otherwise", + "name": "requiresStorageMotion", + "type": "boolean" }, { - "description": "events available for the host", - "name": "events", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, { "description": "the host hypervisor", "name": "hypervisor", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", "name": "cpuwithoverprovisioning", "type": "string" }, + {}, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "long" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -42400,76 +42876,76 @@ "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "response": [ { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "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": "management vlan id of the VSM", "name": "vsmmgmtvlanid", "type": "string" }, - { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" - }, { "description": "device name", "name": "vsmdevicename", "type": "string" }, + {}, { - "description": "device state", - "name": "vsmdevicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "packet vlan id of the VSM", "name": "vsmpktvlanid", "type": "int" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", + "type": "string" + }, + { + "description": "device state", "name": "vsmdevicestate", "type": "string" }, + {}, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" + }, + { + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" } ] }, @@ -42489,6 +42965,7 @@ ], "related": "", "response": [ + {}, { "description": "is domain admin allowed to create offerings with tags", "name": "isallowed", @@ -42504,7 +42981,6 @@ "name": "jobstatus", "type": "integer" }, - {}, {} ] }, @@ -42520,14 +42996,6 @@ "required": false, "type": "string" }, - { - "description": "domain ID of the account owning a VLAN", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, { "description": "project who will own the VLAN", "length": 255, @@ -42550,66 +43018,74 @@ "name": "vlanrange", "required": true, "type": "string" + }, + { + "description": "domain ID of the account owning a VLAN", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" } ], "related": "listDedicatedGuestVlanRanges", "response": [ { - "description": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" - }, - { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "the project id of the guest vlan range", + "name": "projectid", "type": "string" }, - {}, { "description": "the domain ID of the guest VLAN range", "name": "domainid", "type": "string" }, { - "description": "the project name of the guest vlan range", - "name": "project", + "description": "the domain name of the guest VLAN range", + "name": "domain", "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the project id of the guest vlan range", - "name": "projectid", + "description": "the project name of the guest 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 physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" }, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, {}, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" - }, - { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" } ] }, @@ -42619,19 +43095,27 @@ "name": "addNicToVirtualMachine", "params": [ { - "description": "Mac Address for the new network", + "description": "IP Address for the new network", "length": 255, - "name": "macaddress", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "IP Address for the new network", + "description": "Mac Address for the new network", "length": 255, - "name": "ipaddress", + "name": "macaddress", "required": false, "type": "string" }, + { + "description": "Virtual Machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, { "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", "length": 255, @@ -42646,36 +43130,119 @@ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" - }, - { - "description": "Virtual Machine ID", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" } ], "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the ID of the virtual machine", - "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 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 type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + {}, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "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": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -42683,88 +43250,381 @@ "name": "details", "type": "map" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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": "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": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the 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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the account owning the security group", + "name": "account", + "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the project id of the group", + "name": "projectid", "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 ip address of the nic", - "name": "ipaddress", + "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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the 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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "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", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -42772,29 +43632,34 @@ "name": "extradhcpoption", "type": "list" }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, { "description": "true if nic is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -42803,13 +43668,43 @@ "type": "list" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "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 ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -42818,8 +43713,8 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -42828,86 +43723,105 @@ "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" } ], "type": "set" }, - {}, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { "description": "the 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": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -42915,6 +43829,11 @@ "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", @@ -42926,113 +43845,101 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { "description": "tag value", "name": "value", "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" } ], "type": "set" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, - {}, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "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 the disk 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 virtual machine", + "name": "id", "type": "string" }, - {}, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -43041,102 +43948,67 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "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 amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the name of the virtual machine", - "name": "name", + "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 id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the type of the affinity group", - "name": "type", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { @@ -43145,18 +44017,13 @@ "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { @@ -43165,543 +44032,161 @@ "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { "description": "the VM's disk read in KiB", "name": "diskkbsread", "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "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 host for the virtual machine", - "name": "hostname", + "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 group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "OS name of the vm", + "name": "osdisplayname", "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" + } + ] + }, + { + "description": "Lists all static routes", + "isasync": false, + "name": "listStaticRoutes", + "params": [ + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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 account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "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 domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - } - ] - }, - { - "description": "Lists all static routes", - "isasync": false, - "name": "listStaticRoutes", - "params": [ - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list static routes by gateway id", "length": 255, - "name": "isrecursive", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "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.", @@ -43711,18 +44196,19 @@ "type": "boolean" }, { - "description": "list static routes by state", + "description": "list static route by id", "length": 255, - "name": "state", + "name": "id", + "related": "listStaticRoutes", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "keyword", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { "description": "", @@ -43732,27 +44218,25 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "list static routes by state", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list static route by id", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "listStaticRoutes", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list static routes by vpc id", @@ -43763,11 +44247,11 @@ "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "List by keyword", "length": 255, - "name": "tags", + "name": "keyword", "required": false, - "type": "map" + "type": "string" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -43778,52 +44262,89 @@ "type": "uuid" }, { - "description": "list static routes by gateway id", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "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" } ], "related": "", "response": [ + { + "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 static route", + "name": "domainid", + "type": "string" + }, + { + "description": "VPC the static route belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the project name of the static route", + "name": "project", + "type": "string" + }, {}, + { + "description": "the ID of static route", + "name": "id", + "type": "string" + }, { "description": "the domain associated with the static route", "name": "domain", "type": "string" }, - {}, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the account associated with the static route", + "name": "account", + "type": "string" + }, + { + "description": "the state of the static route", + "name": "state", + "type": "string" + }, + { + "description": "the project id of the static route", + "name": "projectid", + "type": "string" + }, + { + "description": "VPC gateway the route is created for", + "name": "gatewayid", + "type": "string" + }, + { + "description": "static route CIDR", + "name": "cidr", "type": "string" }, + {}, { "description": "the list of resource tags associated with static route", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -43832,8 +44353,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -43842,77 +44363,32 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "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": "the ID of static route", - "name": "id", - "type": "string" - }, - { - "description": "VPC gateway the route is created for", - "name": "gatewayid", - "type": "string" - }, - { - "description": "the project name of the static route", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the static route", - "name": "account", - "type": "string" - }, - { - "description": "static route CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project id of the static route", - "name": "projectid", - "type": "string" - }, - { - "description": "the state of the static route", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the domain associated with the static route", - "name": "domainid", - "type": "string" } ] }, @@ -43922,19 +44398,11 @@ "name": "listPublicIpAddresses", "params": [ { - "description": "limits search results to allocated public IP addresses", - "length": 255, - "name": "allocatedonly", - "required": false, - "type": "boolean" - }, - { - "description": "List IPs belonging to the VPC", + "description": "", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -43944,23 +44412,23 @@ "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 state", "length": 255, - "name": "listall", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, @@ -43973,27 +44441,26 @@ "type": "boolean" }, { - "description": "lists all public IP addresses by source network ID", + "description": "list only IPs used for load balancing", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "forloadbalancing", "required": false, - "since": "4.13.0", - "type": "uuid" + "type": "boolean" }, { - "description": "list only source NAT IP addresses", + "description": "List by keyword", "length": 255, - "name": "issourcenat", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "makes the API's response contains only the resource count", @@ -44003,72 +44470,72 @@ "type": "boolean" }, { - "description": "lists the specified IP address", + "description": "list only source NAT IP addresses", "length": 255, - "name": "ipaddress", + "name": "issourcenat", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "limits search results to allocated public IP addresses", "length": 255, - "name": "isrecursive", + "name": "allocatedonly", "required": false, "type": "boolean" }, { - "description": "the virtual network for the IP address", + "description": "List IPs belonging to the VPC", "length": 255, - "name": "forvirtualnetwork", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "lists all public IP addresses associated to the network specified", + "description": "lists all public IP addresses by physical network ID", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "lists all public IP addresses by VLAN ID", + "description": "lists IP address by ID", "length": 255, - "name": "vlanid", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "id", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "lists all public IP addresses by state", + "description": "lists all public IP addresses by VLAN ID", "length": 255, - "name": "state", + "name": "vlanid", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists all public IP addresses by zone ID", + "description": "lists the specified IP address", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "ipaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists all public IP addresses by physical network ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "List resources by tags (key/value pairs)", @@ -44078,32 +44545,41 @@ "type": "map" }, { - "description": "lists IP address by ID", + "description": "list only static NAT IP addresses", "length": 255, - "name": "id", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "isstaticnat", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list only IPs used for load balancing", + "description": "the virtual network for the IP address", "length": 255, - "name": "forloadbalancing", + "name": "forvirtualnetwork", "required": false, "type": "boolean" }, { - "description": "list only static NAT IP addresses", + "description": "lists all public IP addresses by source network ID", "length": 255, - "name": "isstaticnat", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "since": "4.13.0", + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "lists all public IP addresses by zone ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "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" } @@ -44111,23 +44587,8 @@ "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { @@ -44135,103 +44596,38 @@ "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", - "type": "string" - }, - { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", - "type": "string" - }, { "description": "public IP address id", "name": "id", "type": "string" }, - { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "the account the public IP address is associated with", - "name": "account", - "type": "string" - }, - { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" - }, - { - "description": "public IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "VPC id the ip belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { "description": "the list of resource tags associated with ip address", "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", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -44240,88 +44636,112 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, + { + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "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 physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, {}, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the name of the zone the public IP address belongs to", "name": "zonename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is public ip for display to the regular user", + "name": "fordisplay", "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": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -44329,25 +44749,81 @@ "name": "issystem", "type": "boolean" }, - { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, { "description": "true if this ip is for static nat, false otherwise", "name": "isstaticnat", "type": "boolean" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", "name": "vmipaddress", "type": "string" + }, + {}, + { + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" } ] }, @@ -44357,61 +44833,54 @@ "name": "updateIso", "params": [ { - "description": "the name of the image file", + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", "length": 255, - "name": "name", + "name": "cleanupdetails", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "bootable", + "name": "isrouting", "required": false, "type": "boolean" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "the format for the image", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "format", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "requireshvm", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "the format for the image", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "format", - "required": false, - "type": "string" - }, - { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "sshkeyenabled", + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "details", + "name": "requireshvm", "required": false, - "type": "map" + "type": "boolean" }, { "description": "the display text of the image", @@ -44421,127 +44890,103 @@ "type": "string" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "the name of the image file", "length": 255, - "name": "isrouting", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "sort key of the template, integer", + "description": "the ID of the image file", "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" + "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" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "passwordenabled", + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "the ID of the image file", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "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" + "name": "details", + "required": false, + "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": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "cleanupdetails", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" + }, + { + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" } ], "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "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 date this template was created", + "name": "created", + "type": "date" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, - {}, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, { "description": "the 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": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -44550,58 +44995,83 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the template ID", - "name": "id", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "the ID of the secondary storage host for the template", "name": "hostid", @@ -44613,45 +45083,49 @@ "type": "map" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, - {}, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { "description": "true if the reset password feature is enabled, false otherwise", @@ -44659,49 +45133,59 @@ "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "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 physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { "description": "the processor bit size", @@ -44709,13 +45193,13 @@ "type": "int" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the template ID", + "name": "id", "type": "string" }, { @@ -44724,123 +45208,115 @@ "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 date this template was removed", + "name": "removed", + "type": "date" }, + {}, { - "description": "the template name", - "name": "name", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the tag of this template", + "name": "templatetag", "type": "string" } ] }, { - "description": "Lists OpenDaylight controllers", + "description": "Lists OpenDyalight controllers", "isasync": false, "name": "listOpenDaylightControllers", "params": [ { - "description": "the Physical Network ID", + "description": "the ID of a OpenDaylight Controller", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "id", + "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", "required": false, "type": "uuid" }, { - "description": "the ID of a OpenDaylight Controller", + "description": "the Physical Network ID", "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, "type": "uuid" } ], "related": "addOpenDaylightController,deleteOpenDaylightController", "response": [ - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device id of the controller", + "name": "id", + "type": "string" }, + {}, { - "description": "the name assigned to the controller", - "name": "name", + "description": "the url of the controller api", + "name": "url", "type": "string" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device id of the controller", - "name": "id", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the url of the controller api", - "name": "url", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, + {}, { "description": "the username to authenticate to the controller", "name": "username", @@ -44853,13 +45329,6 @@ "isasync": true, "name": "addBigSwitchBcfDevice", "params": [ - { - "description": "Username of the BigSwitch BCF Controller.", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, { "description": "the Physical Network ID", "length": 255, @@ -44875,6 +45344,13 @@ "required": true, "type": "string" }, + { + "description": "Username of the BigSwitch BCF Controller.", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, { "description": "NAT support of the BigSwitch BCF Controller.", "length": 255, @@ -44892,21 +45368,20 @@ ], "related": "listBigSwitchBcfDevices", "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the controller password", + "name": "password", "type": "string" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "device name", @@ -44914,18 +45389,14 @@ "type": "string" }, { - "description": "NAT support", - "name": "nat", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the controller username", + "name": "username", + "type": "string" }, + {}, { - "description": "the controller password", - "name": "password", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, {}, @@ -44935,13 +45406,18 @@ "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "NAT support", + "name": "nat", + "type": "boolean" + }, + { + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the controller username", - "name": "username", + "description": "name of the provider", + "name": "provider", "type": "string" } ], @@ -44962,28 +45438,28 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "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" - }, - {} + } ] }, { @@ -45010,20 +45486,85 @@ ], "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, { "description": "ssh key-pairs", "name": "keypairs", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { "description": "the name of the host for the virtual machine", @@ -45031,23 +45572,38 @@ "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -45055,38 +45611,8 @@ "name": "affinitygroup", "response": [ { - "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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { @@ -45100,132 +45626,151 @@ "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "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", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "tag value", - "name": "value", + "description": "the description of the affinity group", + "name": "description", "type": "string" } ], "type": "set" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, { "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", "name": "displayname", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + {}, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -45234,24 +45779,19 @@ "type": "list" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { "description": "the broadcast uri of the nic", @@ -45259,13 +45799,13 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -45274,19 +45814,19 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { "description": "MTU configured on the NIC", @@ -45294,9 +45834,9 @@ "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "the ID of the corresponding network", @@ -45304,23 +45844,13 @@ "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -45329,14 +45859,14 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the isolated private VLAN if available", @@ -45344,14 +45874,24 @@ "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "name": "macaddress", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { "description": "device id for the network when plugged into the virtual machine", @@ -45362,180 +45902,107 @@ "type": "set" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - {}, - { - "description": "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 ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the incoming network traffic on the VM in KiB", "name": "networkkbsread", "type": "long" }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "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 ID of the security group", + "name": "id", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the 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 name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "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", @@ -45552,13 +46019,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -45567,262 +46029,274 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" + "description": "the 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the 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" + } + ], + "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "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 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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - {}, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "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 name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, + {}, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the 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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "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 vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the 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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { @@ -45831,64 +46305,44 @@ "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the state of the virtual machine", @@ -45896,150 +46350,172 @@ "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - {}, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, { "description": "list of variables and values for the variables declared in userdata", "name": "userdatadetails", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, + {}, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" } ] }, @@ -46048,6 +46524,13 @@ "isasync": false, "name": "generateClusterDrsPlan", "params": [ + { + "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" + }, { "description": "the ID of the Cluster", "length": 255, @@ -46055,42 +46538,26 @@ "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": "executeClusterDrsPlan", "response": [ - {}, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, + {}, { "description": "Start event Id of the DRS Plan", "name": "eventid", "type": "string" }, - { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" - }, {}, { - "description": "List of migrations", - "name": "migrations", - "type": "list" - }, - { - "description": "Id of the cluster", - "name": "clusterid", + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, { @@ -46098,15 +46565,24 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "unique ID of the drs plan for cluster", - "name": "id", - "type": "string" + "description": "List of migrations", + "name": "migrations", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" + }, + { + "description": "Status of DRS Plan", + "name": "status", + "type": "status" + }, + { + "description": "Id of the cluster", + "name": "clusterid", "type": "string" } ], @@ -46127,28 +46603,28 @@ } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -46163,32 +46639,28 @@ "required": true, "type": "string" }, - { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - }, { "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" + }, + { + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "required": true, + "type": "uuid" } ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { @@ -46196,25 +46668,14 @@ "name": "password", "type": "string" }, - {}, - { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" - }, { "description": "the operation result", "name": "status", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -46222,32 +46683,47 @@ "name": "enabled", "type": "boolean" }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, { "description": "the out-of-band management interface powerState of the host", "name": "powerstate", "type": "powerstate" }, - {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "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 out-of-band management interface port", + "name": "port", "type": "string" }, { "description": "the out-of-band management action (if issued)", "name": "action", "type": "string" - } + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" + }, + {} ], "since": "4.9.0" }, @@ -46264,16 +46740,16 @@ "type": "integer" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", - "length": 255, - "name": "provider", + "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": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered", - "length": 65535, - "name": "csr", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "length": 255, + "name": "provider", "required": false, "type": "string" }, @@ -46294,33 +46770,33 @@ ], "related": "listCaCertificate", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The client certificate", + "name": "certificate", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Private key for the certificate", "name": "privatekey", "type": "string" }, - {}, { - "description": "The client certificate", - "name": "certificate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "The CA certificate(s)", "name": "cacertificates", "type": "string" }, - {} + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.11.0" }, @@ -46333,34 +46809,34 @@ "description": "Id of network device to delete", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "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" - }, - {} + } ] }, { @@ -46387,18 +46863,13 @@ "related": "addSecondaryStorage,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { @@ -46407,56 +46878,61 @@ "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" - }, - { - "description": "the ID of the image store", - "name": "id", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, { "description": "the url of the image store", "name": "url", "type": "string" }, - {}, { "description": "the name of the image store", "name": "name", "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" } ], "since": "4.15.0" @@ -46467,24 +46943,39 @@ "name": "createPortForwardingRule", "params": [ { - "description": "VM guest nic secondary IP address for the port forwarding rule", + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true", "length": 255, - "name": "vmguestip", + "name": "openfirewall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the starting port of port forwarding rule's public port range", + "description": "the IP address id of the port forwarding rule", "length": 255, - "name": "publicport", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "length": 255, + "name": "privateport", "required": true, "type": "integer" }, { - "description": "the IP address id of the port forwarding rule", + "description": "the ending port of port forwarding rule's private port range", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "privateendport", + "required": false, + "type": "integer" + }, + { + "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,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, @@ -46504,91 +46995,123 @@ "type": "boolean" }, { - "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", + "description": "VM guest nic secondary IP address for the port forwarding rule", "length": 255, - "name": "protocol", - "required": true, + "name": "vmguestip", + "required": false, "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", + "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", "length": 255, - "name": "privateport", + "name": "protocol", "required": true, - "type": "integer" + "type": "string" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true", + "description": "the 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": "openfirewall", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ending port of port forwarding rule's private port range", + "description": "the starting port of port forwarding rule's public port range", "length": 255, - "name": "publicendport", - "required": false, + "name": "publicport", + "required": true, "type": "integer" }, { "description": "the ending port of port forwarding rule's private port range", "length": 255, - "name": "privateendport", + "name": "publicendport", "required": false, "type": "integer" - }, - { - "description": "the 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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" } ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", + "related": "listPortForwardingRules,updatePortForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", "response": [ { "description": "is firewall for display to the regular user", "name": "fordisplay", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + {}, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, { "description": "the starting port of port forwarding rule's public port range", "name": "publicport", "type": "string" }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "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", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -46597,253 +47120,252 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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 project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "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", + "description": "the state of the rule", + "name": "state", "type": "string" + } + ] + }, + { + "description": "load template into primary storage", + "isasync": false, + "name": "prepareTemplate", + "params": [ + { + "description": "zone ID of the template to be prepared in primary storage(s).", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "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": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + } + ], + "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + {}, + { + "description": "the 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 the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the status of the template", + "name": "status", "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": "Dedicates a zones.", - "isasync": true, - "name": "dedicateZone", - "params": [ + }, { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the domain ID to which the Zone is dedicated", + "description": "the ID of the domain to which the template belongs", "name": "domainid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the Name of the Zone", - "name": "zonename", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, - {}, - {} - ] - }, - { - "description": "load template into primary storage", - "isasync": false, - "name": "prepareTemplate", - "params": [ { - "description": "template ID of the template to be prepared in primary storage(s).", - "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, { - "description": "zone ID of the template to be prepared in primary storage(s).", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" - } - ], - "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, { "description": "the date this template was created", "name": "created", "type": "date" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "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", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the ID of the secondary storage host for the template", @@ -46851,77 +47373,133 @@ "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, + {}, { "description": "true if the ISO is bootable, false otherwise", "name": "bootable", "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the 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" }, { @@ -46930,8 +47508,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -46961,182 +47539,80 @@ } ], "type": "set" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", - "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 reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, + } + ] + }, + { + "description": "Dedicates a zones.", + "isasync": true, + "name": "dedicateZone", + "params": [ { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "checksum of the template", - "name": "checksum", - "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 domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, {}, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the ID of the zone for this template", + "description": "the ID of the Zone", "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", - "type": "boolean" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the dedicated resource", + "name": "id", "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": "the type of the template", - "name": "templatetype", + "description": "the Name of the Zone", + "name": "zonename", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "type": "string" } ] @@ -47166,21 +47642,21 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", + "related": "listPortForwardingRules,updatePortForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -47188,12 +47664,12 @@ "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" + }, + {} ] }, { @@ -47202,55 +47678,56 @@ "name": "listAsyncJobs", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The id of the management server", + "description": "List by keyword", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "keyword", "required": false, - "since": "4.19", - "type": "uuid" + "type": "string" }, { - "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", + "description": "", "length": 255, - "name": "startdate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "The id of the management server", "length": 255, - "name": "page", + "name": "managementserverid", + "related": "listManagementServers", "required": false, - "type": "integer" + "since": "4.19", + "type": "uuid" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -47260,56 +47737,49 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" } ], "related": "queryAsyncJobResult", "response": [ { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", - "type": "long" - }, - { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", + "description": "the user that executed the async command", + "name": "userid", "type": "string" }, - {}, { - "description": " the created date of the job", - "name": "created", - "type": "date" + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", + "type": "string" }, - {}, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": " the completed date of the job", - "name": "completed", - "type": "date" + "description": "the domain that executed the async command", + "name": "domainpath", + "type": "string" }, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "the result type", + "name": "jobresulttype", + "type": "string" }, { - "description": "the result code for the job", - "name": "jobresultcode", + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", "type": "integer" }, + {}, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, { @@ -47318,29 +47788,30 @@ "type": "string" }, { - "description": "the domain id that executed the async command", - "name": "domainid", + "description": "the account that executed the async command", + "name": "account", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, { - "description": "the account that executed the async command", - "name": "account", - "type": "string" + "description": " the created date of the job", + "name": "created", + "type": "date" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", + "description": "the result code for the job", + "name": "jobresultcode", "type": "integer" }, { - "description": "the domain that executed the async command", - "name": "domainpath", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the account id that executed the async command", @@ -47348,19 +47819,24 @@ "type": "string" }, { - "description": "the result type", - "name": "jobresulttype", + "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", + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", + "type": "long" + }, + { + "description": "the current job status-should be 0 for PENDING", "name": "jobstatus", "type": "integer" }, { - "description": "the user that executed the async command", - "name": "userid", - "type": "string" + "description": " the completed date of the job", + "name": "completed", + "type": "date" } ] }, @@ -47370,11 +47846,11 @@ "name": "archiveAlerts", "params": [ { - "description": "archive by alert type", + "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": "type", + "name": "enddate", "required": false, - "type": "string" + "type": "date" }, { "description": "the IDs of the alerts", @@ -47392,24 +47868,14 @@ "type": "date" }, { - "description": "end date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "archive by alert type", "length": 255, - "name": "enddate", + "name": "type", "required": false, - "type": "date" + "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", @@ -47421,6 +47887,16 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -47429,6 +47905,13 @@ "isasync": false, "name": "listBuckets", "params": [ + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "List resources by tags (key/value pairs)", "length": 255, @@ -47437,56 +47920,56 @@ "type": "map" }, { - "description": "the IDs of the Buckets, mutually exclusive with id", + "description": "List by keyword", "length": 255, - "name": "ids", - "related": "listBuckets", + "name": "keyword", "required": false, - "type": "list" + "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 ID of the bucket", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "listBuckets", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the ID of the object storage pool, available to ROOT admin only", + "description": "", "length": 255, - "name": "objectstorageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the bucket", + "description": "the IDs of the Buckets, mutually exclusive with id", "length": 255, - "name": "name", + "name": "ids", + "related": "listBuckets", "required": false, - "type": "string" + "type": "list" }, { - "description": "List by keyword", + "description": "the ID of the object storage pool, available to ROOT admin only", "length": 255, - "name": "keyword", + "name": "objectstorageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "type": "uuid" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -47495,20 +47978,6 @@ "required": false, "type": "boolean" }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. 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, @@ -47518,25 +47987,57 @@ "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the bucket", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "listBuckets", "required": false, "type": "uuid" + }, + { + "description": "the name of the bucket", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "", "response": [ + { + "description": "Bucket Access Key", + "name": "accesskey", + "type": "string" + }, + { + "description": "Object storage provider", + "name": "provider", + "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 date the Bucket was created", + "name": "created", + "type": "date" + }, + { + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" + }, + { + "description": "the ID of the domain associated with the bucket", + "name": "domainid", "type": "string" }, { - "description": "ID of the Bucket", - "name": "id", + "description": "the project id of the bucket", + "name": "projectid", "type": "string" }, { @@ -47545,8 +48046,13 @@ "type": "string" }, { - "description": "Bucket URL", - "name": "url", + "description": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" + }, + { + "description": "Bucket Secret Key", + "name": "usersecretkey", "type": "string" }, { @@ -47555,13 +48061,43 @@ "type": "integer" }, { - "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": "Bucket Access Key", - "name": "accesskey", + "description": "ID of the Bucket", + "name": "id", + "type": "string" + }, + { + "description": "name of the Bucket", + "name": "name", + "type": "string" + }, + { + "description": "Bucket URL", + "name": "url", + "type": "string" + }, + { + "description": "Bucket Access Policy", + "name": "policy", + "type": "string" + }, + { + "description": "the account associated with the Bucket", + "name": "account", + "type": "string" + }, + { + "description": "State of the Bucket", + "name": "state", + "type": "string" + }, + { + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", "type": "string" }, { @@ -47569,28 +48105,28 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the 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": "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": "tag value", + "name": "value", "type": "string" }, { @@ -47599,8 +48135,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -47609,194 +48145,293 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "name of the Bucket", - "name": "name", - "type": "string" + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" }, { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", + "description": "the project name of the bucket", + "name": "project", "type": "string" }, { - "description": "the project id of the bucket", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" - }, - { - "description": "Object storage provider", - "name": "provider", + "description": "the domain associated with the bucket", + "name": "domain", "type": "string" }, + {}, { - "description": "Bucket Object Locking", - "name": "objectlocking", + "description": "Bucket Versioning", + "name": "versioning", "type": "boolean" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "Deletes a Cisco Vnmc controller", + "isasync": false, + "name": "deleteCiscoVnmcResource", + "params": [ { - "description": "State of the Bucket", - "name": "state", - "type": "string" - }, + "description": "Cisco Vnmc resource ID", + "length": 255, + "name": "resourceid", + "related": "listCiscoVnmcResources", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the project name of the bucket", - "name": "project", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the domain associated with the bucket", - "name": "domain", - "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": "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 secondary storage selector, described by the heuristic rule.", + "isasync": false, + "name": "createSecondaryStorageSelector", + "params": [ + { + "description": "The zone in which the heuristic rule will be applied.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "Bucket Secret Key", - "name": "usersecretkey", + "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 description of the heuristic rule.", + "length": 255, + "name": "description", + "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.", + "length": 255, + "name": "type", + "required": true, + "type": "string" + }, + { + "description": "The name identifying the heuristic rule.", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "updateSecondaryStorageSelector,removeSecondaryStorageSelector", + "response": [ + { + "description": "Name of the heuristic.", + "name": "name", + "type": "string" + }, + {}, + { + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the date the Bucket was created", + "description": "ID of the heuristic.", + "name": "id", + "type": "string" + }, + { + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", + "type": "string" + }, + { + "description": "When the heuristic was created.", "name": "created", "type": "date" }, { - "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": "Bucket Versioning", - "name": "versioning", - "type": "boolean" + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", + "type": "string" }, { - "description": "the account associated with the Bucket", - "name": "account", - "type": "string" + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, - {}, { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" + "description": "Description of the heuristic.", + "name": "description", + "type": "string" } ], "since": "4.19.0" }, { - "description": "Deletes a Cisco Vnmc controller", - "isasync": false, - "name": "deleteCiscoVnmcResource", + "description": "Stops an Internal LB vm.", + "isasync": true, + "name": "stopInternalLoadBalancerVM", "params": [ { - "description": "Cisco Vnmc resource ID", + "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": "resourceid", - "related": "listCiscoVnmcResources", + "name": "forced", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the internal lb vm", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "required": true, "type": "uuid" } ], + "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Creates a secondary storage selector, described by the heuristic rule.", - "isasync": false, - "name": "createSecondaryStorageSelector", - "params": [ + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "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 first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "The name identifying the heuristic rule.", - "length": 255, - "name": "name", - "required": true, + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "The description of the heuristic rule.", - "length": 255, - "name": "description", - "required": true, + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "The zone in which the heuristic rule will be applied.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the version of template", + "name": "version", + "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "length": 255, - "name": "type", - "required": true, + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" - } - ], - "related": "updateSecondaryStorageSelector,removeSecondaryStorageSelector", - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + {}, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" }, {}, { @@ -47805,75 +48440,118 @@ "type": "string" }, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "When the heuristic was removed.", - "name": "removed", + "description": "the date and time the router was created", + "name": "created", "type": "date" }, { - "description": "Description of the heuristic.", - "name": "description", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "ID of the heuristic.", - "name": "id", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "Name of the heuristic.", - "name": "name", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" + "description": "role of the domain router", + "name": "role", + "type": "string" }, - {} - ], - "since": "4.19.0" - }, - { - "description": "Stops an Internal LB vm.", - "isasync": true, - "name": "stopInternalLoadBalancerVM", - "params": [ { - "description": "the ID of the internal lb vm", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" }, { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - } - ], - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "response": [ + }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the 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 name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { @@ -47881,78 +48559,83 @@ "name": "nic", "response": [ { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "name": "isdefault", + "type": "boolean" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -47961,18 +48644,18 @@ "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -47981,161 +48664,76 @@ "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "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": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" } ], "type": "set" }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, { "description": "the hypervisor on which the template runs", "name": "hypervisor", "type": "string" }, { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "role of the domain router", - "name": "role", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { @@ -48143,9 +48741,14 @@ "name": "healthcheckresults", "response": [ { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { "description": "the name of the health check on the router", @@ -48153,82 +48756,31 @@ "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { "description": "detailed response generated on running health check", "name": "details", "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" } ], "type": "list" }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - {}, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, { "description": "true if the router template requires upgrader", "name": "requiresupgrade", "type": "boolean" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { @@ -48236,100 +48788,24 @@ "name": "publicnetworkid", "type": "string" }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - {}, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "true if any health checks had failed", "name": "healthchecksfailed", "type": "boolean" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the project name of the address", + "name": "project", "type": "string" } ] @@ -48357,14 +48833,14 @@ { "description": "Credentials to access the Brocade VCS Switch API", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, { "description": "Credentials to access the Brocade VCS Switch API", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" } @@ -48376,14 +48852,19 @@ "name": "hostname", "type": "string" }, + { + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "brocadedevicename", "type": "string" }, {}, @@ -48392,17 +48873,12 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", - "type": "string" - }, - { - "description": "device name", - "name": "brocadedevicename", + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { "description": "name of the provider", "name": "provider", @@ -48415,14 +48891,6 @@ "isasync": false, "name": "updateSecurityGroup", "params": [ - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, { "description": "The new name of the security group.", "length": 255, @@ -48437,17 +48905,86 @@ "related": "createSecurityGroup,updateSecurityGroup", "required": true, "type": "uuid" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" } ], "related": "createSecurityGroup", "response": [ + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + {}, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the 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", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -48456,13 +48993,13 @@ "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -48475,13 +49012,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -48490,13 +49022,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -48505,38 +49037,38 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the 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 CIDR notation for the base IP address of the security group rule", "name": "cidr", @@ -48551,232 +49083,176 @@ "type": "set" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "tag key name", - "name": "key", - "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": "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": "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": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], "type": "set" }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, {}, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "security group name", - "name": "securitygroupname", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "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": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "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 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 project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.14.0.0" @@ -48786,6 +49262,13 @@ "isasync": false, "name": "createDomain", "params": [ + { + "description": "creates domain with this name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "Domain UUID, required for adding domain from another Region", "length": 255, @@ -48800,13 +49283,6 @@ "required": false, "type": "string" }, - { - "description": "creates domain with this name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.", "length": 255, @@ -48819,18 +49295,28 @@ "related": "listDomainChildren,listDomains,listDomains", "response": [ { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" }, + { + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { @@ -48839,83 +49325,104 @@ "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, + { + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, { "description": "the date when this domain was created", "name": "created", "type": "date" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" }, + {}, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { @@ -48924,33 +49431,43 @@ "type": "long" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the name of the domain", + "name": "name", "type": "string" }, { @@ -48958,15 +49475,15 @@ "name": "projecttotal", "type": "long" }, - {}, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, + {}, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { @@ -48975,8 +49492,8 @@ "type": "boolean" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { @@ -48984,96 +49501,55 @@ "name": "icon", "type": "resourceiconresponse" }, - { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" - }, - {}, { "description": "the total memory (in MB) available to be created for this domain", "name": "memoryavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the path of the domain", - "name": "path", - "type": "string" - }, - { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, - { - "description": "the name of the domain", - "name": "name", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" } ] }, @@ -49082,13 +49558,6 @@ "isasync": true, "name": "deleteTags", "params": [ - { - "description": "Delete tags matching key/value pairs", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, { "description": "Delete tag by resource type", "length": 255, @@ -49096,6 +49565,13 @@ "required": true, "type": "string" }, + { + "description": "Delete tags matching key/value pairs", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, { "description": "Delete tags for resource id(s)", "length": 255, @@ -49105,28 +49581,28 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.0.0" }, @@ -49135,13 +49611,6 @@ "isasync": true, "name": "createTungstenFabricTagType", "params": [ - { - "description": "Tungsten-Fabric tag type name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -49149,42 +49618,49 @@ "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric tag type name", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "listTungstenFabricTagType", "response": [ - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "Tungsten-Fabric tag type name", "name": "name", "type": "string" }, - {}, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -49225,28 +49701,28 @@ } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "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" - }, - {} + } ] }, { @@ -49262,17 +49738,17 @@ "type": "string" }, { - "description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", "length": 255, - "name": "password", - "required": true, + "name": "domain", + "required": false, "type": "string" }, { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", "length": 255, - "name": "domain", - "required": false, + "name": "password", + "required": true, "type": "string" }, { @@ -49286,34 +49762,24 @@ "related": "", "response": [ { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" - }, - { - "description": "first name of the user", - "name": "firstname", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "user time zone", - "name": "timezone", + "description": "User ID", + "name": "userid", "type": "string" }, { - "description": "Username", - "name": "username", - "type": "string" + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" }, { "description": "Two factor authentication provider", @@ -49326,22 +49792,20 @@ "type": "string" }, { - "description": "the account name the user belongs to", - "name": "account", + "description": "user time zoneoffset", + "name": "timezoneoffset", "type": "string" }, - {}, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", - "type": "string" + "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", + "description": "user time zone", + "name": "timezone", "type": "string" }, - {}, { "description": "Is two factor authentication verified", "name": "is2faverified", @@ -49352,9 +49816,20 @@ "name": "domainid", "type": "string" }, + {}, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "last name of the user", + "name": "lastname", + "type": "string" + }, + { + "description": "first name of the user", + "name": "firstname", + "type": "string" + }, + { + "description": "the account name the user belongs to", + "name": "account", "type": "string" }, { @@ -49363,18 +49838,19 @@ "type": "string" }, { - "description": "User ID", - "name": "userid", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Username", + "name": "username", "type": "string" }, { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -49385,71 +49861,55 @@ "name": "listHypervisorCapabilities", "params": [ { - "description": "the hypervisor for which to restrict the search", + "description": "List by keyword", "length": 255, - "name": "hypervisor", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "pagesize", + "name": "hypervisor", "required": false, - "type": "integer" + "type": "string" }, { - "description": "ID of the hypervisor capability", + "description": "", "length": 255, - "name": "id", - "related": "listHypervisorCapabilities", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "ID of the hypervisor capability", "length": 255, - "name": "keyword", + "name": "id", + "related": "listHypervisorCapabilities", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ - { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" - }, - {}, { "description": "true if security group is supported", "name": "securitygroupenabled", "type": "boolean" }, + {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" }, - {}, { "description": "the maximum number of guest vms recommended for this hypervisor", "name": "maxguestslimit", @@ -49461,25 +49921,41 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the hypervisor type", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", "type": "integer" }, { - "description": "the hypervisor type", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + { + "description": "true if storage motion is supported", + "name": "storagemotionenabled", + "type": "boolean" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, { "description": "true if VM snapshots are enabled for this hypervisor", "name": "vmsnapshotenabled", "type": "boolean" - } + }, + {} ], "since": "3.0.0" }, @@ -49489,18 +49965,19 @@ "name": "addImageStore", "params": [ { - "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "description": "the name for the image store", "length": 255, - "name": "details", + "name": "name", "required": false, - "type": "map" + "type": "string" }, { - "description": "the name for the image store", + "description": "the Zone ID for the image store", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the image store provider name", @@ -49510,12 +49987,11 @@ "type": "string" }, { - "description": "the Zone ID for the image store", + "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { "description": "the URL for the image store", @@ -49527,11 +50003,10 @@ ], "related": "addSecondaryStorage,listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ - {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, { "description": "the Zone ID of the image store", @@ -49539,24 +50014,14 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", + "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 name of the image store", - "name": "name", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { @@ -49565,39 +50030,50 @@ "type": "boolean" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { "description": "the url of the image store", "name": "url", "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 protocol of the image store", - "name": "protocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the image store", + "name": "name", + "type": "string" } ], "since": "4.2.0" @@ -49608,11 +50084,12 @@ "name": "revokeTemplateDirectDownloadCertificate", "params": [ { - "description": "(optional) hypervisor type", + "description": "(optional) the host ID to revoke certificate", "length": 255, - "name": "hypervisor", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { "description": "(optional) alias of the SSL certificate", @@ -49622,64 +50099,63 @@ "type": "string" }, { - "description": "(optional) zone to revoke certificate", + "description": "id of the certificate", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "id", + "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", + "required": false, "type": "uuid" }, { - "description": "(optional) the host ID to revoke certificate", + "description": "(optional) zone to revoke certificate", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" }, { - "description": "id of the certificate", + "description": "(optional) hypervisor type", "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" } ], "related": "provisionTemplateDirectDownloadCertificate", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the host", + "name": "hostname", + "type": "string" }, - {}, { "description": "indicates the details in case of failure or host skipped", "name": "details", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "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": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", - "type": "string" - } + {} ], "since": "4.13" }, @@ -49699,61 +50175,54 @@ ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "response": [ - { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" - }, { "description": "the tags for the storage pool", "name": "tags", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, - {}, { - "description": "the storage pool path", - "name": "path", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { @@ -49762,89 +50231,96 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, + {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "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": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "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 name of the storage pool", - "name": "name", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" } ], "since": "4.16.0" @@ -49872,17 +50348,18 @@ } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -49892,8 +50369,7 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.15.0" }, @@ -49910,14 +50386,6 @@ "required": false, "type": "uuid" }, - { - "description": "The ID of the volume to be reassigned.", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": true, - "type": "uuid" - }, { "description": "The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'.", "length": 255, @@ -49925,58 +50393,66 @@ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" + }, + { + "description": "The ID of the volume to be reassigned.", + "length": 255, + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" } ], "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "pod id of the volume", + "name": "podid", "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": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "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": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "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": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { @@ -49985,55 +50461,39 @@ "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, - {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { "description": "pod name of the volume", @@ -50041,73 +50501,38 @@ "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, { "description": "size of the disk volume", "name": "size", "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -50115,36 +50540,25 @@ "name": "physicalsize", "type": "long" }, - {}, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { "description": "the date the volume was attached to a VM instance", @@ -50152,53 +50566,43 @@ "type": "date" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the status of the volume", - "name": "status", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { @@ -50206,122 +50610,194 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "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": "the project id of the vpn", - "name": "projectid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "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": "state of the virtual machine", + "name": "vmstate", "type": "string" }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, { "description": "ID of the disk volume", "name": "id", "type": "string" }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + {}, { "description": "ID of the service offering for root disk", "name": "serviceofferingid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, + {}, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" } ], "since": "4.18.0.0" @@ -50332,20 +50808,19 @@ "name": "deleteUserData", "params": [ { - "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "description": "an optional project for the userdata", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "an optional project for the userdata", + "description": "an optional account for the userdata. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the ID of the Userdata", @@ -50356,11 +50831,12 @@ "type": "uuid" }, { - "description": "an optional account for the userdata. Must be used with domainId.", + "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" } ], "response": [ @@ -50370,126 +50846,160 @@ "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, {} ], "since": "4.18" }, { - "description": "Get SolidFire Account ID", + "description": "Create a quota balance statement", "isasync": false, - "name": "getSolidFireAccountId", + "name": "quotaBalance", "params": [ { - "description": "CloudStack Account UUID", + "description": "Start date range quota 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 usage records for the specified account", "length": 255, "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Storage Pool UUID", + "description": "Account Id for which statement needs to be generated", "length": 255, - "name": "storageid", + "name": "account", "required": true, "type": "string" + }, + { + "description": "End date range for quota query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" } ], "related": "", "response": [ - {}, { - "description": "SolidFire Account ID", - "name": "solidFireAccountId", + "description": "domain id", + "name": "domain", "type": "long" }, - {}, + { + "description": "usage type name", + "name": "name", + "type": "string" + }, + { + "description": "account name", + "name": "account", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "usage type", + "name": "type", + "type": "int" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "account id", + "name": "accountid", + "type": "long" + }, + {}, + { + "description": "usage unit", + "name": "unit", + "type": "string" + }, + {}, + { + "description": "quota consumed", + "name": "quota", + "type": "bigdecimal" } - ] + ], + "since": "4.7.0" }, { - "description": "Lists role permissions", + "description": "Get SolidFire Account ID", "isasync": false, - "name": "listRolePermissions", + "name": "getSolidFireAccountId", "params": [ { - "description": "ID of the role", + "description": "CloudStack Account UUID", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" + "name": "accountid", + "required": true, + "type": "string" + }, + { + "description": "Storage Pool UUID", + "length": 255, + "name": "storageid", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" - }, - {}, - { - "description": "the ID of the role permission", - "name": "id", - "type": "string" + "description": "SolidFire Account ID", + "name": "solidFireAccountId", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" - }, {}, - { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", - "type": "string" - }, - { - "description": "the description of the role permission", - "name": "description", - "type": "string" } - ], - "since": "4.9.0" + ] }, { "description": "Lists all network services provided by CloudStack or for the given Provider.", @@ -50497,43 +51007,71 @@ "name": "listSupportedNetworkServices", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "network service name to list providers and capabilities of", + "description": "network service provider name", "length": 255, - "name": "service", + "name": "provider", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "network service provider name", + "description": "network service name to list providers and capabilities of", "length": 255, - "name": "provider", + "name": "service", "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + {}, { "description": "the service provider name", "name": "provider", @@ -50544,24 +51082,19 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "the provider name", @@ -50569,54 +51102,92 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "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 current status of the latest async job 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 role permissions", + "isasync": false, + "name": "listRolePermissions", + "params": [ + { + "description": "ID of the role", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the role permission", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", + "type": "string" + }, {}, + { + "description": "the api name or wildcard rule", + "name": "rule", + "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 service name", - "name": "name", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" + "description": "the name of the role to which the role permission belongs", + "name": "rolename", + "type": "string" + }, + { + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", + "type": "string" } ], - "since": "3.0.0" + "since": "4.9.0" }, { "description": "Deletes a particular ingress rule from this security group", @@ -50633,28 +51204,28 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -50663,77 +51234,77 @@ "name": "listDedicatedGuestVlanRanges", "params": [ { - "description": "list dedicated guest vlan ranges by id", + "description": "project who will own the guest VLAN range", "length": 255, - "name": "id", - "related": "listDedicatedGuestVlanRanges", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the dedicated guest vlan range", + "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", "length": 255, - "name": "guestvlanrange", + "name": "account", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "physical network id of the guest VLAN range", + "description": "zone of the guest VLAN range", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", + "description": "the dedicated guest vlan range", "length": 255, - "name": "account", + "name": "guestvlanrange", "required": false, "type": "string" }, { - "description": "zone of the guest VLAN range", + "description": "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "project who will own the guest VLAN range", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "physical network id of the guest VLAN range", "length": 255, - "name": "page", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", + "description": "list dedicated guest vlan ranges by id", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "id", + "related": "listDedicatedGuestVlanRanges", "required": false, "type": "uuid" } @@ -50741,18 +51312,8 @@ "related": "", "response": [ { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", - "type": "string" - }, - { - "description": "the guest VLAN range", - "name": "guestvlanrange", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, { @@ -50760,38 +51321,48 @@ "name": "projectid", "type": "string" }, + {}, { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", + "description": "the zone of the guest vlan range", + "name": "zoneid", "type": "long" }, + {}, { "description": "the account of the guest VLAN range", "name": "account", "type": "string" }, { - "description": "the project name of the guest vlan range", - "name": "project", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID of the guest VLAN range", + "name": "domainid", "type": "string" }, { - "description": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" + "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 project name of the guest vlan range", + "name": "project", + "type": "string" }, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, + { + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" + }, { "description": "the domain name of the guest VLAN range", "name": "domain", @@ -50843,13 +51414,13 @@ "type": "string" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { @@ -50858,15 +51429,15 @@ "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { "description": "services for this provider", @@ -50880,9 +51451,9 @@ "type": "string" }, { - "description": "the provider name", - "name": "name", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "since": "3.0.0" @@ -50893,42 +51464,48 @@ "name": "listNetworkACLs", "params": [ { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list network ACL items by protocol", + "description": "list network ACL items by action", "length": 255, - "name": "protocol", + "name": "action", "required": false, "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list network ACL items by traffic type - ingress or egress", "length": 255, - "name": "tags", + "name": "traffictype", "required": false, - "type": "map" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "Lists network ACL Item with the specified ID", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "id", + "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", "required": false, "type": "uuid" }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, @@ -50937,48 +51514,49 @@ "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list network ACL items by network ID", "length": 255, - "name": "listall", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list network ACL items by action", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "action", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Lists network ACL Item with the specified ID", + "description": "list network ACL items by protocol", "length": 255, - "name": "id", - "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list network ACL items by ACL ID", + "description": "", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -50989,69 +51567,93 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "list network ACL items by traffic type - ingress or egress", + "description": "list network ACL items by ACL ID", "length": 255, - "name": "traffictype", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list network ACL items by network ID", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", "response": [ { - "description": "Number of the ACL Item", - "name": "number", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, - {}, { "description": "the ID of the ACL Item", "name": "id", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + {}, { "description": "Action of ACL Item. Allow/Deny", "name": "action", "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "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 protocol of the ACL", + "name": "protocol", "type": "string" }, { @@ -51059,38 +51661,53 @@ "name": "fordisplay", "type": "boolean" }, + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, + { + "description": "the starting port of ACL's port range", + "name": "startport", + "type": "string" + }, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -51099,104 +51716,98 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" } ], "type": "list" - }, + } + ] + }, + { + "description": "Delete site to site vpn gateway", + "isasync": true, + "name": "deleteVpnGateway", + "params": [ { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" + "description": "id of customer gateway", + "length": 255, + "name": "id", + "related": "createVpnGateway,listVpnGateways,updateVpnGateway", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" - }, - { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - }, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - {} + } ] }, { - "description": "Delete site to site vpn gateway", - "isasync": true, - "name": "deleteVpnGateway", + "description": "Marks a quota tariff as removed.", + "isasync": false, + "name": "quotaTariffDelete", "params": [ { - "description": "id of customer gateway", + "description": "ID of the quota tariff", "length": 255, "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", + "related": "quotaTariffCreate", "required": true, - "type": "uuid" + "type": "string" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } - ] + ], + "since": "4.18.0.0" }, { "description": "Creates a service offering.", @@ -51204,90 +51815,90 @@ "name": "createServiceOffering", "params": [ { - "description": "max iops of the compute offering", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "maxiops", + "name": "byteswriteratemax", "required": false, - "since": "4.4", "type": "long" }, { - "description": "is this a system vm offering", + "description": "VMs using this offering require root volume encryption", "length": 255, - "name": "issystem", + "name": "encryptroot", "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "systemvmtype", + "name": "bytesreadratemax", "required": false, - "type": "string" + "type": "long" }, { - "description": "the tags for this service offering.", + "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "tags", + "name": "systemvmtype", "required": false, "type": "string" }, { - "description": "burst bytes write rate of the disk offering", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, - "name": "byteswriteratemax", + "name": "cachemode", "required": false, - "type": "long" + "since": "4.14", + "type": "string" }, { - "description": "bytes write rate of the disk offering", + "description": "max iops of the compute offering", "length": 255, - "name": "byteswriterate", + "name": "maxiops", "required": false, + "since": "4.4", "type": "long" }, { - "description": "the Root disk size in GB.", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "rootdisksize", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "since": "4.15", - "type": "long" + "type": "list" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "iopsreadrate", "required": false, - "since": "4.4", - "type": "integer" + "type": "long" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "description": "length (in seconds) of the burst", "length": 255, - "name": "diskofferingstrictness", + "name": "byteswriteratemaxlength", "required": false, - "since": "4.17", - "type": "boolean" + "type": "long" }, { - "description": "bytes read rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "bytesreadrate", + "name": "bytesreadratemaxlength", "required": false, "type": "long" }, { - "description": "length (in seconds) of the burst", + "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": "bytesreadratemaxlength", + "name": "deploymentplanner", "required": false, - "type": "long" + "type": "string" }, { - "description": "the CPU speed of the service offering in MHz.", + "description": "the total memory of the service offering in MB", "length": 255, - "name": "cpuspeed", + "name": "memory", "required": false, "type": "integer" }, @@ -51300,91 +51911,88 @@ "type": "integer" }, { - "description": "The display text of the service offering, defaults to 'name'.", + "description": "The minimum memory size of the custom service offering in MB", "length": 255, - "name": "displaytext", + "name": "minmemory", "required": false, - "type": "string" + "since": "4.13", + "type": "integer" }, { - "description": "burst io requests write rate of the disk offering", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "iopswriteratemax", + "name": "hypervisorsnapshotreserve", "required": false, - "type": "long" + "since": "4.4", + "type": "integer" }, { - "description": "VMs using this offering require root volume encryption", + "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": "encryptroot", + "name": "diskofferingstrictness", "required": false, - "since": "4.18", + "since": "4.17", "type": "boolean" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "bytesreadrate", "required": false, - "type": "list" + "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "details for planner, used to store specific parameters", "length": 255, - "name": "provisioningtype", + "name": "serviceofferingdetails", "required": false, - "type": "string" + "type": "map" }, { - "description": "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used", + "description": "restrict the CPU usage to committed service offering", "length": 255, - "name": "deploymentplanner", + "name": "limitcpuuse", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "description": "Whether service offering size is custom or not", "length": 255, - "name": "dynamicscalingenabled", + "name": "customized", "required": false, - "since": "4.16", + "since": "4.13", "type": "boolean" }, { - "description": "io requests read rate of the disk offering", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "iopsreadrate", + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", "required": false, - "type": "long" + "since": "4.15", + "type": "uuid" }, { - "description": "the total memory of the service offering in MB", + "description": "the CPU number of the service offering", "length": 255, - "name": "memory", + "name": "cpunumber", "required": false, "type": "integer" }, { - "description": "restrict the CPU usage to committed service offering", - "length": 255, - "name": "limitcpuuse", - "required": false, - "type": "boolean" - }, - { - "description": "details for planner, used to store specific parameters", + "description": "The minimum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "serviceofferingdetails", + "name": "mincpunumber", "required": false, - "type": "map" + "since": "4.13", + "type": "integer" }, { - "description": "the host tag for this service offering.", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "hosttags", + "name": "iopswriteratemax", "required": false, - "type": "string" + "type": "long" }, { "description": "whether compute offering iops is custom or not", @@ -51395,115 +52003,113 @@ "type": "boolean" }, { - "description": "The minimum memory size of the custom service offering in MB", + "description": "min iops of the compute offering", "length": 255, - "name": "minmemory", + "name": "miniops", "required": false, - "since": "4.13", - "type": "integer" + "since": "4.4", + "type": "long" }, { - "description": "Whether service offering size is custom or not", + "description": "length (in seconds) of the burst", "length": 255, - "name": "customized", + "name": "iopsreadratemaxlength", "required": false, - "since": "4.13", - "type": "boolean" + "type": "long" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "the CPU speed of the service offering in MHz.", "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", + "name": "cpuspeed", "required": false, - "since": "4.15", - "type": "uuid" + "type": "integer" }, { - "description": "the name of the service offering", + "description": "the host tag for this service offering.", "length": 255, - "name": "name", - "required": true, + "name": "hosttags", + "required": false, "type": "string" }, { - "description": "min iops of the compute offering", + "description": "The display text of the service offering, defaults to 'name'.", "length": 255, - "name": "miniops", + "name": "displaytext", "required": false, - "since": "4.4", - "type": "long" + "type": "string" }, { - "description": "The minimum number of CPUs to be set with Custom Computer Offering", + "description": "is this a system vm offering", "length": 255, - "name": "mincpunumber", + "name": "issystem", "required": false, - "since": "4.13", - "type": "integer" + "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "networkrate", + "name": "byteswriterate", "required": false, - "type": "integer" + "type": "long" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", "length": 255, - "name": "storagetype", + "name": "dynamicscalingenabled", "required": false, - "type": "string" + "since": "4.16", + "type": "boolean" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "cachemode", + "name": "provisioningtype", "required": false, - "since": "4.14", "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "the name of the service offering", "length": 255, - "name": "iopswriteratemaxlength", - "required": false, - "type": "long" + "name": "name", + "required": true, + "type": "string" }, { - "description": "true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "isvolatile", + "name": "iopswriterate", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the HA for the service offering", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "offerha", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "since": "4.13", + "type": "list" }, { - "description": "io requests write rate of the disk offering", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "iopswriterate", + "name": "storagetype", "required": false, - "type": "long" + "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "the HA for the service offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "offerha", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "the CPU number of the service offering", + "description": "The maximum memory size of the custom service offering in MB", "length": 255, - "name": "cpunumber", + "name": "maxmemory", "required": false, + "since": "4.13", "type": "integer" }, { @@ -51516,40 +52122,45 @@ "type": "uuid" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "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": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "isvolatile", "required": false, - "since": "4.13", - "type": "list" + "type": "boolean" }, { - "description": "burst requests read rate of the disk offering", + "description": "the Root disk size in GB.", "length": 255, - "name": "iopsreadratemax", + "name": "rootdisksize", "required": false, + "since": "4.15", "type": "long" }, { - "description": "burst bytes read rate of the disk offering", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "bytesreadratemax", + "name": "iopsreadratemax", "required": false, "type": "long" }, { - "description": "The maximum memory size of the custom service offering in MB", + "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", "length": 255, - "name": "maxmemory", + "name": "networkrate", "required": false, - "since": "4.13", "type": "integer" }, + { + "description": "the tags for this service offering.", + "length": 255, + "name": "tags", + "required": false, + "type": "string" + }, { "description": "length (in seconds) of the burst", "length": 255, - "name": "byteswriteratemaxlength", + "name": "iopswriteratemaxlength", "required": false, "type": "long" } @@ -51557,116 +52168,99 @@ "related": "updateServiceOffering,listServiceOfferings", "response": [ { - "description": "an alternate display text of the service offering.", - "name": "displaytext", - "type": "string" - }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "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 virtual machine root disk will be encrypted on storage", + "name": "encryptroot", "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, - { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { "description": "the ha support in the service offering", "name": "offerha", "type": "boolean" }, - {}, - {}, + { + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" + }, { "description": "the ID of the disk offering to which service offering is linked", "name": "diskofferingid", "type": "string" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" - }, - { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", "type": "boolean" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, + { + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" + }, { "description": "the display text of the disk offering", "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "Root disk size in GB", + "name": "rootdisksize", "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": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "the name of the service offering", + "name": "name", + "type": "string" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, { "description": "is this a system vm offering", @@ -51674,48 +52268,39 @@ "type": "boolean" }, { - "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": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { "description": "bytes write rate of the service offering", "name": "diskBytesWriteRate", "type": "long" }, + {}, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "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": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { @@ -51724,38 +52309,49 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, + { + "description": "the date this service offering was created", + "name": "created", + "type": "date" + }, { "description": "deployment strategy used to deploy VM.", "name": "deploymentplanner", "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 service offering", + "name": "id", "type": "string" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "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 domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { @@ -51764,64 +52360,79 @@ "type": "integer" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "the tags for the service offering", - "name": "storagetags", - "type": "string" + "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", + "name": "isvolatile", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the name of the service offering", - "name": "name", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", + "type": "string" }, { - "description": "the id of the service offering", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "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": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" + }, { "description": "the max iops of the disk offering", "name": "maxiops", "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" } ] }, @@ -51831,12 +52442,12 @@ "name": "copyTemplate", "params": [ { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "description": "ID of the zone the template is being copied to.", "length": 255, - "name": "destzoneids", + "name": "destzoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "list" + "type": "uuid" }, { "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", @@ -51847,12 +52458,12 @@ "type": "uuid" }, { - "description": "ID of the zone the template is being copied to.", + "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": "destzoneid", + "name": "destzoneids", "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "uuid" + "type": "list" }, { "description": "Template ID.", @@ -51865,60 +52476,102 @@ ], "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" - }, - { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" - }, { "description": "the type of the template", "name": "templatetype", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", - "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": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the project id of the template", + "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", - "type": "string" + "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 date this template was created", + "name": "created", + "type": "date" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { "description": "the ID of the OS type for this template.", @@ -51926,14 +52579,14 @@ "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the physical size of the template", @@ -51941,24 +52594,8 @@ "type": "long" }, { - "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 URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { @@ -51967,34 +52604,24 @@ "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "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": "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 zone for this template", + "name": "zonename", + "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 status of the template", @@ -52002,24 +52629,24 @@ "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { "description": "the ID of the zone for this template", @@ -52027,14 +52654,14 @@ "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { "description": "the account id to which the template belongs", @@ -52042,152 +52669,136 @@ "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, + {}, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, - {}, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, { "description": "the name of the domain to which the template belongs", "name": "domain", "type": "string" }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, { "description": "true if the reset password feature is enabled, false otherwise", "name": "passwordenabled", "type": "boolean" }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, { "description": "true if the template is ready to be deployed from, false otherwise.", "name": "isready", "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" } ] }, @@ -52196,14 +52807,6 @@ "isasync": false, "name": "listNiciraNvpDeviceNetworks", "params": [ - { - "description": "nicira nvp device ID", - "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", - "required": true, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -52218,6 +52821,14 @@ "required": false, "type": "integer" }, + { + "description": "nicira nvp device ID", + "length": 255, + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, @@ -52229,18 +52840,18 @@ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { @@ -52249,149 +52860,126 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, + {}, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the list of services", - "name": "service", + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", "response": [ { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - } - ], - "type": "list" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the service name", - "name": "name", + "description": "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": "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": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { @@ -52400,64 +52988,49 @@ "type": "boolean" }, { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "the owner of the network", - "name": "account", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the type of the network", @@ -52465,8 +53038,8 @@ "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { @@ -52475,8 +53048,8 @@ "type": "integer" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { @@ -52485,63 +53058,63 @@ "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the owner of the network", + "name": "account", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { @@ -52550,151 +53123,109 @@ "type": "set" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "list" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "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": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "true if network can span multiple zones", @@ -52702,29 +53233,109 @@ "type": "boolean" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "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" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, - {}, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, {} @@ -52751,13 +53362,6 @@ "required": false, "type": "list" }, - { - "description": "account name of the new VM owner.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "domain id of the new VM owner.", "length": 255, @@ -52766,14 +53370,6 @@ "required": false, "type": "uuid" }, - { - "description": "id of the VM to be moved", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, { "description": "an optional project for the new VM owner.", "length": 255, @@ -52781,120 +53377,28 @@ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" - } - ], - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "account name of the new VM owner.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, + "description": "id of the VM to be moved", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "response": [ { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { @@ -52903,18 +53407,8 @@ "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 account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { @@ -52923,363 +53417,197 @@ "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", + "description": "the ID of the security group", "name": "id", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -53295,38 +53623,38 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "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": "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": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -53338,14 +53666,44 @@ "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], "type": "set" @@ -53356,67 +53714,27 @@ "type": "string" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project name of the group", + "name": "project", "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -53425,163 +53743,127 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "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 number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the type of the affinity group", + "name": "type", + "type": "string" }, { - "description": "the description of the security group", + "description": "the description of the affinity group", "name": "description", "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" } ], "type": "set" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, + {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -53590,145 +53872,148 @@ "type": "string" }, { - "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": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the project name of the vm", + "name": "project", "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 availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, - {}, { - "description": "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 domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "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 user's ID who deployed the virtual machine", + "name": "userid", "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 read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "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 write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, + { + "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" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { @@ -53737,226 +54022,180 @@ "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the 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 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 group ID of the virtual machine", - "name": "groupid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "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 type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the virtual machine", + "name": "name", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists virtual machines on a unmanaged host", - "isasync": false, - "name": "listVmsForImport", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" }, { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the username for the host", - "length": 255, - "name": "username", - "required": false, + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the host name or IP address", - "length": 255, - "name": "host", - "required": true, - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the password for the host", - "length": 255, - "name": "password", - "required": false, + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "hypervisor type of the host", - "length": 255, - "name": "hypervisor", - "required": true, + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" - } - ], - "related": "listVmwareDcVms,listUnmanagedInstances", - "response": [ + }, { - "description": "the list of nics associated with the virtual machine", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "id of the resource", + "name": "resourceid", "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": "macaddress", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ { "description": "the isolation uri of the nic", "name": "isolationuri", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { "description": "the IPv6 address of network", @@ -53964,33 +54203,38 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -53999,28 +54243,28 @@ "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { @@ -54029,195 +54273,562 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", - "type": "string" - }, - { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", - "type": "string" - }, - { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" - }, - { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the list of disks associated with the virtual machine", - "name": "disk", - "response": [ + }, { - "description": "the ID of the disk", - "name": "id", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "the position of the disk", - "name": "position", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "controller", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the controller of the disk", - "name": "datastorename", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorehost", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the label of the disk", - "name": "label", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" - }, - { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" } ], "type": "set" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", - "type": "string" - }, - { - "description": "the CPU cores of the virtual machine", + "description": "the number of vCPUs this virtual machine is using", "name": "cpunumber", "type": "integer" }, + {}, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, - {}, - {} - ], - "since": "4.19.0" - }, - { - "description": " delete a BigSwitch BCF Controller device", - "isasync": true, - "name": "deleteBigSwitchBcfDevice", - "params": [ { - "description": "BigSwitch device ID", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "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": "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": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "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", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists virtual machines on a unmanaged host", + "isasync": false, + "name": "listVmsForImport", + "params": [ + { + "description": "the password for the host", "length": 255, - "name": "bcfdeviceid", - "related": "listBigSwitchBcfDevices", + "name": "password", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the username for the host", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the host name or IP address", + "length": 255, + "name": "host", + "required": true, + "type": "string" + }, + { + "description": "hypervisor type of the host", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" } ], + "related": "listVmwareDcVms,listUnmanagedInstances", "response": [ + { + "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 name of the cluster to which virtual machine belongs", + "name": "clustername", + "type": "string" + }, + {}, + { + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", + "type": "string" + }, + { + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + }, + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "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": "datastorepath", + "type": "string" + } + ], + "type": "set" + }, + { + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolated private VLAN 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": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "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 ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the 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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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" + } + ], + "type": "set" + }, + { + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the operating system ID of the virtual machine", + "name": "osid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" + }, + { + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" + }, + { + "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 power state of the virtual machine", + "name": "powerstate", + "type": "string" + }, + { + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" + } + ], + "since": "4.19.0" + }, + { + "description": " delete a BigSwitch BCF Controller device", + "isasync": true, + "name": "deleteBigSwitchBcfDevice", + "params": [ + { + "description": "BigSwitch device ID", + "length": 255, + "name": "bcfdeviceid", + "related": "listBigSwitchBcfDevices", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -54228,13 +54839,6 @@ "isasync": true, "name": "configureNetscalerLoadBalancer", "params": [ - { - "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", - "length": 255, - "name": "lbdevicededicated", - "required": false, - "type": "boolean" - }, { "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", "length": 255, @@ -54244,11 +54848,12 @@ "type": "list" }, { - "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": "Netscaler load balancer device ID", "length": 255, - "name": "inline", - "required": false, - "type": "boolean" + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "required": true, + "type": "uuid" }, { "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", @@ -54258,30 +54863,41 @@ "type": "long" }, { - "description": "Netscaler load balancer device ID", + "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": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "required": true, - "type": "uuid" + "name": "lbdevicededicated", + "required": false, + "type": "boolean" + }, + { + "description": "true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", + "length": 255, + "name": "inline", + "required": false, + "type": "boolean" } ], "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ + {}, { "description": "true if NetScaler device is provisioned to be a GSLB service provider", "name": "gslbprovider", "type": "boolean" }, - {}, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + { + "description": "device name", + "name": "lbdevicename", "type": "string" }, { @@ -54290,44 +54906,29 @@ "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "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 capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - { - "description": "name of the provider", - "name": "provider", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" - }, { "description": "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": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -54335,23 +54936,33 @@ "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, + { + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" + }, { "description": "device id of the netscaler load balancer", "name": "lbdeviceid", "type": "string" }, { - "description": "device name", - "name": "lbdevicename", + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + }, + { + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "name of the provider", + "name": "provider", "type": "string" }, {} @@ -54362,13 +54973,6 @@ "isasync": false, "name": "listOvsElements", "params": [ - { - "description": "list network offerings by enabled state", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" - }, { "description": "list ovs elements by id", "length": 255, @@ -54384,6 +54988,14 @@ "required": false, "type": "string" }, + { + "description": "list ovs elements by network service provider id", + "length": 255, + "name": "nspid", + "related": "listNetworkServiceProviders,listTrafficTypes", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -54399,38 +55011,30 @@ "type": "integer" }, { - "description": "list ovs elements by network service provider id", + "description": "list network offerings by enabled state", "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders,listTrafficTypes", + "name": "enabled", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "configureOvsElement", "response": [ { - "description": "the id of the ovs", - "name": "id", - "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 physical network service provider id of the provider", - "name": "nspid", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, - {}, - {}, { "description": "the project id of the ipaddress", "name": "projectid", @@ -54441,24 +55045,31 @@ "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "the project name of the address", - "name": "project", + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the id of the ovs", + "name": "id", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" } ] @@ -54469,19 +55080,19 @@ "name": "deleteTungstenFabricServiceGroup", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric service group", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "servicegroupuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric service group", + "description": "the ID of zone", "length": 255, - "name": "servicegroupuuid", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ @@ -54490,22 +55101,22 @@ "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, @@ -54515,11 +55126,12 @@ "name": "associateUcsProfileToBlade", "params": [ { - "description": "profile dn", + "description": "blade id", "length": 255, - "name": "profiledn", + "name": "bladeid", + "related": "associateUcsProfileToBlade", "required": true, - "type": "string" + "type": "uuid" }, { "description": "ucs manager id", @@ -54530,16 +55142,20 @@ "type": "uuid" }, { - "description": "blade id", + "description": "profile dn", "length": 255, - "name": "bladeid", - "related": "associateUcsProfileToBlade", + "name": "profiledn", "required": true, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ + { + "description": "associated ucs profile dn", + "name": "profiledn", + "type": "string" + }, { "description": "cloudstack host id this blade associates to", "name": "hostid", @@ -54552,13 +55168,14 @@ "type": "string" }, { - "description": "ucs blade dn", - "name": "bladedn", + "description": "ucs blade id", + "name": "id", "type": "string" }, + {}, { - "description": "associated ucs profile dn", - "name": "profiledn", + "description": "ucs manager id", + "name": "ucsmanagerid", "type": "string" }, { @@ -54566,15 +55183,9 @@ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "ucs manager id", - "name": "ucsmanagerid", - "type": "string" - }, { - "description": "ucs blade id", - "name": "id", + "description": "ucs blade dn", + "name": "bladedn", "type": "string" } ] @@ -54585,18 +55196,18 @@ "name": "addObjectStoragePool", "params": [ { - "description": "the tags for the storage pool", + "description": "the object store provider name", "length": 255, - "name": "tags", - "required": false, + "name": "provider", + "required": true, "type": "string" }, { - "description": "the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the URL for the object store", + "length": 2048, + "name": "url", + "required": true, + "type": "string" }, { "description": "the name for the object store", @@ -54606,36 +55217,37 @@ "type": "string" }, { - "description": "the URL for the object store", - "length": 2048, - "name": "url", - "required": true, - "type": "string" + "description": "the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the object store provider name", + "description": "the tags for the storage pool", "length": 255, - "name": "provider", - "required": true, + "name": "tags", + "required": false, "type": "string" } ], "related": "", "response": [ { - "description": "the name of the object store", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the object store", - "name": "id", + "description": "the url of the object store", + "name": "url", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the provider name of the object store", + "name": "providername", + "type": "string" }, { "description": "the object store currently used size", @@ -54643,8 +55255,13 @@ "type": "long" }, { - "description": "the url of the object store", - "name": "url", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the object store", + "name": "id", "type": "string" }, { @@ -54653,72 +55270,18 @@ "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 provider name of the object store", - "name": "providername", - "type": "string" - }, - {} - ], - "since": "4.19.0" - }, - { - "description": "Deletes user from the project", - "isasync": true, - "name": "deleteUserFromProject", - "params": [ - { - "description": "ID of the project to remove the user from", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, - { - "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" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the object store", + "name": "name", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {} ], - "since": "4.15.0" + "since": "4.19.0" }, { "description": "Updates a VMware datacenter details for a zone", @@ -54726,16 +55289,23 @@ "name": "updateVmwareDc", "params": [ { - "description": "The username required to connect to resource.", + "description": "The password for specified username.", "length": 255, - "name": "username", + "name": "password", "required": false, "type": "string" }, { - "description": "VMware datacenter name.", + "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": "name", + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "length": 255, + "name": "vcenter", "required": false, "type": "string" }, @@ -54748,50 +55318,91 @@ "type": "uuid" }, { - "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "The password for specified username.", + "description": "VMware datacenter name.", "length": 255, - "name": "password", + "name": "name", "required": false, "type": "string" }, { - "description": "The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "The username required to connect to resource.", "length": 255, - "name": "vcenter", + "name": "username", "required": false, "type": "string" } ], "related": "addVmwareDc,listVmwareDcs", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" + }, { "description": "The VMware Datacenter ID", "name": "id", "type": "string" }, - {}, { "description": "The VMware Datacenter name", "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "The VMware vCenter name/ip", "name": "vcenter", "type": "string" }, + {} + ], + "since": "4.12.0" + }, + { + "description": "Deletes user from the project", + "isasync": true, + "name": "deleteUserFromProject", + "params": [ + { + "description": "ID of the project to remove the user from", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" + }, + { + "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" + } + ], + "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", @@ -54799,12 +55410,12 @@ }, {}, { - "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" } ], - "since": "4.12.0" + "since": "4.15.0" }, { "description": "Checks the 2FA code for the user.", @@ -54820,27 +55431,27 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.18.0" @@ -54868,28 +55479,28 @@ ], "related": "", "response": [ + { + "description": "the id of the router", + "name": "routerid", + "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 router", - "name": "routerid", - "type": "string" - }, - {}, { "description": "the id of the router", "name": "healthchecks", "type": "list" - }, - {} + } ], "since": "4.14.0" }, @@ -54898,13 +55509,6 @@ "isasync": false, "name": "listNetscalerControlCenter", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -54918,6 +55522,13 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", @@ -54927,37 +55538,37 @@ "name": "ipaddress", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "uuid", + "name": "uuid", "type": "string" }, { - "description": "id", - "name": "id", + "description": "username", + "name": "username", "type": "string" }, { - "description": "uuid", - "name": "uuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "num_retries", - "name": "numretries", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "username", - "name": "username", + "description": "id", + "name": "id", "type": "string" }, {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "num_retries", + "name": "numretries", + "type": "string" } ] }, @@ -54966,13 +55577,6 @@ "isasync": true, "name": "resizeVolume", "params": [ - { - "description": "New maximum number of IOPS", - "length": 255, - "name": "maxiops", - "required": false, - "type": "long" - }, { "description": "Verify OK to Shrink", "length": 255, @@ -54988,13 +55592,20 @@ "type": "long" }, { - "description": "new disk offering id", + "description": "the ID of the disk volume", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": false, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, "type": "uuid" }, + { + "description": "New maximum number of IOPS", + "length": 255, + "name": "maxiops", + "required": false, + "type": "long" + }, { "description": "New minimum number of IOPS", "length": 255, @@ -55003,139 +55614,139 @@ "type": "long" }, { - "description": "the ID of the disk volume", + "description": "new disk offering id", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": false, "type": "uuid" } ], "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "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 boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, { "description": "the status of the volume", "name": "status", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "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 account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { @@ -55144,65 +55755,54 @@ "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - {}, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { "description": "volume uuid that is given by virtualisation provider (only for VMware)", @@ -55210,38 +55810,33 @@ "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", - "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": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { @@ -55249,31 +55844,20 @@ "name": "quiescevm", "type": "boolean" }, - {}, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, { - "description": "the project name of the vpn", - "name": "project", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { "description": "the name of the ISO attached to the virtual machine", @@ -55281,33 +55865,28 @@ "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { @@ -55315,97 +55894,129 @@ "name": "tags", "response": [ { - "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + {}, + { + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, + {}, { - "description": "the state of the disk volume", - "name": "state", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "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": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" } ] }, @@ -55414,13 +56025,6 @@ "isasync": true, "name": "deleteAffinityGroup", "params": [ - { - "description": "the account of the affinity group. Must be specified with domain ID", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "the domain ID of account owning the affinity group", "length": 255, @@ -55430,19 +56034,19 @@ "type": "uuid" }, { - "description": "the project of the affinity group", + "description": "The name of the affinity group. Mutually exclusive with ID parameter", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The name of the affinity group. Mutually exclusive with ID parameter", + "description": "the project of the affinity group", "length": 255, - "name": "name", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "The ID of the affinity group. Mutually exclusive with name parameter", @@ -55451,30 +56055,37 @@ "related": "", "required": false, "type": "uuid" + }, + { + "description": "the account of the affinity group. Must be specified with domain ID", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, @@ -55493,27 +56104,27 @@ } ], "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "the UUID of the latest async job acting 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" @@ -55533,11 +56144,6 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -55550,54 +56156,8 @@ "type": "boolean" }, { - "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 ID of the Pod", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" - } - ], - "related": "listDedicatedPods", - "response": [ - {}, - { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the Pod", - "name": "podid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, @@ -55605,46 +56165,15 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the Name of the Pod", - "name": "podname", - "type": "string" - }, - { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, - { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", - "type": "string" } - ] + ], + "since": "3.0.0" }, { "description": "List network devices", "isasync": false, "name": "listNetworkDevice", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", "length": 255, @@ -55666,6 +56195,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -55676,23 +56212,23 @@ ], "related": "addNetworkDevice", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the network device", + "name": "id", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the network device", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -55715,12 +56251,11 @@ "type": "string" }, { - "description": "UUID of storage network ip range", + "description": "Optional. the vlan the ip range sits on", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", - "required": true, - "type": "uuid" + "name": "vlan", + "required": false, + "type": "integer" }, { "description": "the netmask for storage network", @@ -55730,26 +56265,63 @@ "type": "string" }, { - "description": "Optional. the vlan the ip range sits on", + "description": "UUID of storage network ip range", "length": 255, - "name": "vlan", - "required": false, - "type": "integer" + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", + "required": true, + "type": "uuid" } ], "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "response": [ + { + "description": "the gateway of the storage network IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "the start ip of the storage network IP range", + "name": "startip", + "type": "string" + }, + { + "description": "the Pod uuid for the storage network IP range", + "name": "podid", + "type": "string" + }, { "description": "the ID or VID of the VLAN.", "name": "vlan", "type": "integer" }, + { + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", + "type": "string" + }, + {}, + {}, + { + "description": "the network uuid of storage network IP range", + "name": "networkid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "the netmask of the storage network IP range", + "name": "netmask", + "type": "string" + }, { "description": "the uuid of storage network IP range.", "name": "id", @@ -55759,45 +56331,84 @@ "description": "the end ip of the storage network IP range", "name": "endip", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Dedicates a Pod.", + "isasync": true, + "name": "dedicatePod", + "params": [ + { + "description": "the ID of the Pod", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", - "type": "string" + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": true, + "type": "uuid" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, - {}, + } + ], + "related": "listDedicatedPods", + "response": [ { - "description": "the Pod uuid for the storage network IP range", + "description": "the ID of the Pod", "name": "podid", "type": "string" }, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, + {}, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Name of the Pod", + "name": "podname", + "type": "string" } - ], - "since": "3.0.0" + ] }, { "description": "Lists Project roles in CloudStack", @@ -55813,18 +56424,18 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "List project role by project role ID.", @@ -55837,7 +56448,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -55851,25 +56462,21 @@ ], "related": "createProjectRole,updateProjectRole", "response": [ - { - "description": "the ID of the role", - "name": "id", - "type": "string" - }, - {}, { "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", "name": "ispublic", "type": "boolean" }, + {}, + {}, { - "description": "the name of the role", - "name": "name", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the name of the role", + "name": "name", "type": "string" }, { @@ -55877,22 +56484,26 @@ "name": "jobid", "type": "string" }, - { - "description": "the id of the project", - "name": "projectid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + { + "description": "the description of the role", + "name": "description", + "type": "string" + }, + { + "description": "the id of the project", + "name": "projectid", + "type": "string" + } ], "since": "4.15.0" }, { - "description": "Removes an OpenDaylight controller", + "description": "Removes an OpenDyalight controler", "isasync": true, "name": "deleteOpenDaylightController", "params": [ @@ -55908,15 +56519,16 @@ "related": "addOpenDaylightController", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device id of the controller", + "name": "id", + "type": "string" }, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, + {}, { "description": "the physical network to which this controller belongs to", "name": "physicalnetworkid", @@ -55927,22 +56539,21 @@ "name": "url", "type": "string" }, - {}, { - "description": "the name assigned to the controller", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, {}, { - "description": "device id of the controller", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -55951,20 +56562,6 @@ "isasync": false, "name": "updateTemplate", "params": [ - { - "description": "sort key of the template, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, - { - "description": "true if the image supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" - }, { "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, @@ -55973,16 +56570,9 @@ "type": "boolean" }, { - "description": "the format for the image", - "length": 255, - "name": "format", - "required": false, - "type": "string" - }, - { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "cleanupdetails", + "name": "requireshvm", "required": false, "type": "boolean" }, @@ -55994,25 +56584,27 @@ "type": "boolean" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "sort key of the template, integer", "length": 255, - "name": "requireshvm", + "name": "sortkey", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "the ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "templatetype", + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "the ID of the image file", "length": 255, - "name": "details", - "required": false, - "type": "map" + "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 template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", @@ -56029,9 +56621,23 @@ "type": "boolean" }, { - "description": "the name of the image file", + "description": "the format for the image", "length": 255, - "name": "name", + "name": "format", + "required": false, + "type": "string" + }, + { + "description": "true if the image supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "length": 255, + "name": "templatetype", "required": false, "type": "string" }, @@ -56043,37 +56649,42 @@ "type": "string" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "the name of the image file", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the image file", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "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" + "name": "details", + "required": false, + "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)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" } ], "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "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 tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { @@ -56082,165 +56693,174 @@ "type": "string" }, { - "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 URL which the template/iso is registered from", - "name": "url", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the template ID", - "name": "id", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, + {}, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { "description": "the userdata override policy with the userdata provided while deploying VM", "name": "userdatapolicy", "type": "string" }, - {}, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, - {}, { - "description": "the template display text", - "name": "displaytext", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "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": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { @@ -56249,32 +56869,72 @@ "type": "map" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "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" }, { @@ -56282,6 +56942,16 @@ "name": "account", "type": "string" }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, { "description": "customer associated with the tag", "name": "customer", @@ -56298,92 +56968,33 @@ "type": "string" }, { - "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" } ], "type": "set" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the template name", "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" } ] }, @@ -56393,46 +57004,47 @@ "name": "createVlanIpRange", "params": [ { - "description": "true if VLAN is of Virtual type, false if Direct", + "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", "length": 255, - "name": "forvirtualnetwork", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "domain ID of the account owning a VLAN", + "description": "the network id", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "startipv6", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", "length": 255, - "name": "endipv6", + "name": "ip6gateway", "required": false, "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the physical network id", "length": 255, - "name": "startipv6", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "description": "the ending IP address in the VLAN IP range", "length": 255, - "name": "account", + "name": "endip", "required": false, "type": "string" }, @@ -56444,35 +57056,34 @@ "type": "string" }, { - "description": "the network id", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "endipv6", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "forsystemvms", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the netmask of the VLAN IP range", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "netmask", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the beginning IP address in the VLAN IP range", @@ -56482,18 +57093,18 @@ "type": "string" }, { - "description": "the ending IP address in the VLAN IP range", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "endip", + "name": "ip6cidr", "required": false, "type": "string" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", + "description": "true if VLAN is of Virtual type, false if Direct", "length": 255, - "name": "ip6gateway", + "name": "forvirtualnetwork", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged", @@ -56503,114 +57114,110 @@ "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, - "name": "ip6cidr", + "name": "account", "required": false, "type": "string" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, - "name": "forsystemvms", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the physical network id", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "netmask", "required": false, - "type": "uuid" + "type": "string" } ], "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "response": [ { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", + "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, + {}, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, {}, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { @@ -56619,24 +57226,23 @@ "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, - {}, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { @@ -56645,18 +57251,23 @@ "type": "integer" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" } ] @@ -56666,6 +57277,14 @@ "isasync": true, "name": "updateVpnConnection", "params": [ + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, { "description": "id of vpn connection", "length": 255, @@ -56681,73 +57300,38 @@ "required": false, "since": "4.4", "type": "boolean" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" } ], "related": "createVpnConnection,listVpnConnections", "response": [ - {}, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "the project name", - "name": "project", - "type": "string" - }, - { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" - }, - {}, { "description": "State of vpn connection", - "name": "state", - "type": "string" - }, - { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "name": "passive", + "type": "boolean" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the owner", + "name": "account", "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 project id", - "name": "projectid", + "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" }, { @@ -56756,39 +57340,39 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the connection ID", + "name": "id", "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": "the domain name of the owner", - "name": "domain", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -56796,18 +57380,39 @@ "type": "integer" }, { - "description": "the connection ID", - "name": "id", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + {}, + { + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" + }, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "the project id", + "name": "projectid", "type": "string" }, { @@ -56816,19 +57421,25 @@ "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, { "description": "the customer gateway ID", "name": "s2scustomergatewayid", "type": "string" }, + {}, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" } ], "since": "4.4" @@ -56846,18 +57457,18 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "palo alto balancer device ID", @@ -56871,74 +57482,49 @@ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "the id of the network", - "name": "id", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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 second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "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": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, { "description": "true if network supports specifying ip ranges, false otherwise", @@ -56946,283 +57532,139 @@ "type": "boolean" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the name of the Network associated with this network", + "description": "the name of the Network associated with this private gateway", "name": "associatednetwork", "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": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "related to what other network configuration", - "name": "related", - "type": "string" - }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, { "description": "true if users from subdomains can access the domain level network", "name": "subdomainaccess", "type": "boolean" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", - "type": "string" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - {}, - { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the id of the network", + "name": "id", + "type": "string" }, { "description": "the total number of network traffic bytes sent", "name": "sentbytes", "type": "long" }, - {}, - { - "description": "the name of the network", - "name": "name", - "type": "string" - }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "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": "network offering id the network is created from", - "name": "networkofferingid", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { "description": "ACL name associated with the VPC network", @@ -57230,58 +57672,48 @@ "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" - }, - { - "description": "the type of the network", - "name": "type", - "type": "string" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the type of the network", + "name": "type", "type": "string" }, { "description": "the list of services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, { "description": "the capability value", "name": "value", @@ -57291,32 +57723,27 @@ "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": "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", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -57330,14 +57757,19 @@ "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], "type": "list" @@ -57346,18 +57778,24 @@ "type": "list" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { @@ -57366,41 +57804,33 @@ "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" - } - ] - }, - { - "description": "Synchronize Tungsten-Fabric data", - "isasync": false, - "name": "synchronizeTungstenFabricData", - "params": [ + }, { - "description": "provider id", - "length": 255, - "name": "id", - "related": "listTungstenFabricProviders", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the name of the network", + "name": "name", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { @@ -57408,67 +57838,240 @@ "name": "jobstatus", "type": "integer" }, - {} - ] - }, - { - "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 routing mode of network offering", + "name": "ip6routing", "type": "string" - } - ], - "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 path field for the volume", - "name": "path", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists management servers.", + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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": "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" + } + ], + "type": "list" + }, + {}, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + } + ] + }, + { + "description": "Synchronize Tungsten-Fabric data", "isasync": false, - "name": "listManagementServers", + "name": "synchronizeTungstenFabricData", "params": [ { - "description": "the id of the management server", + "description": "provider id", "length": 255, "name": "id", - "related": "listManagementServers", - "required": false, + "related": "listTungstenFabricProviders", + "required": true, "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Get the path associated with the provided volume UUID", + "isasync": false, + "name": "getPathForVolume", + "params": [ + { + "description": "CloudStack Volume UUID", "length": 255, - "name": "pagesize", - "required": false, + "name": "volumeid", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The path field for the volume", + "name": "path", + "type": "string" + }, + {} + ] + }, + { + "description": "Lists management servers.", + "isasync": false, + "name": "listManagementServers", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -57480,55 +58083,58 @@ "type": "string" }, { - "description": "List by keyword", + "description": "the id of the management server", "length": 255, - "name": "keyword", + "name": "id", + "related": "listManagementServers", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the state of the management server", - "name": "state", - "type": "state" - }, - { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "the version of the management server", + "name": "version", + "type": "string" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "the IP Address for this Management Server", + "name": "serviceip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the management server", + "name": "id", "type": "string" }, { - "description": "the IP Address for this Management Server", - "name": "serviceip", + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "the version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" }, { - "description": "the name of the management server", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the version of the management server", - "name": "version", - "type": "string" + "description": "the state of the management server", + "name": "state", + "type": "state" }, { "description": "the running OS kernel version for this Management Server", @@ -57537,14 +58143,14 @@ }, {}, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", + "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": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" }, { "description": "the last time this Management Server was started", @@ -57552,13 +58158,18 @@ "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "type": "string" }, { - "description": "the ID of the management server", - "name": "id", + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" + }, + { + "description": "the name of the management server", + "name": "name", "type": "string" } ] @@ -57569,101 +58180,100 @@ "name": "listTungstenFabricPolicyRule", "params": [ { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "keyword", - "required": false, + "name": "policyuuid", + "required": true, "type": "string" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric rule", + "description": "", "length": 255, - "name": "ruleuuid", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the uuid of Tungsten-Fabric rule", "length": 255, - "name": "policyuuid", - "required": true, + "name": "ruleuuid", + "required": false, "type": "string" } ], "related": "addTungstenFabricPolicyRule", "response": [ { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", "type": "string" }, { - "description": "Tungsten-Fabric policy action", - "name": "action", - "type": "string" + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", "type": "int" }, { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", "type": "string" }, { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", - "type": "int" + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", "type": "string" }, { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { @@ -57672,13 +58282,18 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", + "description": "Tungsten-Fabric policy name", + "name": "direction", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", "type": "int" }, { @@ -57687,29 +58302,25 @@ "type": "int" }, { - "description": "Tungsten-Fabric policy name", - "name": "direction", - "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", + "type": "int" }, + {}, { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", - "type": "int" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -57718,13 +58329,6 @@ "isasync": true, "name": "deleteTungstenFabricPolicy", "params": [ - { - "description": "the Uuid of Tungsten-Fabric tag type", - "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -57732,26 +58336,33 @@ "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "the Uuid of Tungsten-Fabric tag type", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "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", @@ -57782,32 +58393,30 @@ ], "related": "createInstanceGroup", "response": [ - {}, - {}, { - "description": "the domain ID of the instance group", - "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", - "type": "boolean" + "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 instance group", + "name": "id", "type": "string" }, { - "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 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 domain name of the instance group", @@ -57815,14 +58424,16 @@ "type": "string" }, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, + {}, + {}, { - "description": "the 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 name of the instance group", @@ -57830,13 +58441,13 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the instance group", - "name": "id", + "description": "the project name of the instance group", + "name": "project", "type": "string" } ] @@ -57847,11 +58458,11 @@ "name": "changeOfferingForVolume", "params": [ { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", "length": 255, - "name": "maxiops", + "name": "automigrate", "required": false, - "type": "long" + "type": "boolean" }, { "description": "new disk offering id", @@ -57862,16 +58473,23 @@ "type": "uuid" }, { - "description": "New minimum number of IOPS for the custom disk offering", + "description": "New volume size in GB for the custom disk offering", "length": 255, - "name": "miniops", + "name": "size", "required": false, "type": "long" }, { - "description": "New volume size in GB for the custom disk offering", + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "size", + "name": "maxiops", + "required": false, + "type": "long" + }, + { + "description": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", "required": false, "type": "long" }, @@ -57889,50 +58507,93 @@ "name": "shrinkok", "required": false, "type": "boolean" - }, - { - "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", - "length": 255, - "name": "automigrate", - "required": false, - "type": "boolean" } ], "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the disk utilization", - "name": "utilization", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "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" }, { @@ -57941,39 +58602,64 @@ "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, + {}, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { @@ -57982,38 +58668,48 @@ "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { @@ -58027,105 +58723,120 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, + {}, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "tag key name", "name": "key", @@ -58141,19 +58852,14 @@ "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", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -58162,47 +58868,27 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the status of the volume", - "name": "status", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "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", - "type": "string" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { "description": "type of the virtual machine", @@ -58210,89 +58896,14 @@ "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "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": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the state of the disk volume", - "name": "state", - "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": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" } ], "since": "4.17" @@ -58302,10 +58913,18 @@ "isasync": false, "name": "listTemplateDirectDownloadCertificates", "params": [ + { + "description": "list direct download certificate by ID", + "length": 255, + "name": "id", + "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -58317,6 +58936,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "List by keyword", "length": 255, @@ -58330,64 +58956,45 @@ "name": "listhosts", "required": false, "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list direct download certificate by ID", - "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", - "required": false, - "type": "uuid" } ], "related": "uploadTemplateDirectDownloadCertificate", "response": [ { - "description": "the direct download certificate serial num", - "name": "serialnum", - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the direct download certificate id", - "name": "id", + "description": "the direct download certificate issuer", + "name": "validity", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, + {}, + {}, { "description": "the hosts where the certificate is uploaded to", "name": "hostsmap", "type": "list" }, - {}, { - "description": "the direct download certificate alias", - "name": "alias", + "description": "the direct download certificate issuer", + "name": "issuer", "type": "string" }, { - "description": "the direct download certificate subject", - "name": "subject", + "description": "the direct download certificate id", + "name": "id", + "type": "string" + }, + { + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, { @@ -58396,8 +59003,13 @@ "type": "integer" }, { - "description": "the direct download certificate issuer", - "name": "validity", + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the direct download certificate alias", + "name": "alias", "type": "string" }, { @@ -58405,15 +59017,14 @@ "name": "version", "type": "string" }, - {}, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "issuer", + "description": "the zone name where the certificate is uploaded", + "name": "zonename", "type": "string" } ], @@ -58432,18 +59043,18 @@ "type": "string" }, { - "description": "the zone id", + "description": "the ID of the ucs manager", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "listUcsManagers,addUcsManager", "required": false, "type": "uuid" }, { - "description": "the ID of the ucs manager", + "description": "the zone id", "length": 255, - "name": "id", - "related": "listUcsManagers,addUcsManager", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, @@ -58464,16 +59075,9 @@ ], "related": "addUcsManager", "response": [ - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of ucs manager", - "name": "name", + "description": "the ID of the ucs manager", + "name": "id", "type": "string" }, { @@ -58481,19 +59085,26 @@ "name": "url", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the ucs manager", - "name": "id", + "description": "the zone ID of ucs manager", + "name": "zoneid", "type": "string" }, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "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" } ] @@ -58523,74 +59134,69 @@ "related": "destroyRouter,listRouters,listInternalLoadBalancerVMs", "response": [ { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the 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 ID of the corresponding link local network", @@ -58598,99 +59204,58 @@ "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, - {}, { "description": "the version of the code / software in the router", "name": "softwareversion", "type": "string" }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, { "description": "the Zone name for the router", "name": "zonename", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { @@ -58698,78 +59263,53 @@ "name": "nic", "response": [ { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, { "description": "device id for the network when plugged into the virtual machine", "name": "deviceid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -58783,53 +59323,53 @@ "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -58838,68 +59378,61 @@ "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "result of the health check", - "name": "success", + "description": "true if nic is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], - "type": "list" + "type": "set" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -58908,28 +59441,28 @@ "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { @@ -58938,8 +59471,29 @@ "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -58947,40 +59501,97 @@ "name": "name", "type": "string" }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, {}, { - "description": "the project name of the address", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", "type": "string" } ] @@ -58990,13 +59601,6 @@ "isasync": false, "name": "deleteLdapConfiguration", "params": [ - { - "description": "port", - "length": 255, - "name": "port", - "required": false, - "type": "integer" - }, { "description": "Hostname", "length": 255, @@ -59011,20 +59615,27 @@ "related": "listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" + }, + { + "description": "port", + "length": 255, + "name": "port", + "required": false, + "type": "integer" } ], "related": "addLdapConfiguration", "response": [ + { + "description": "name of the host running the ldap server", + "name": "hostname", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "port the ldap server is running on", "name": "port", @@ -59033,8 +59644,8 @@ {}, {}, { - "description": "name of the host running the ldap server", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -59050,13 +59661,6 @@ "isasync": true, "name": "updateVolume", "params": [ - { - "description": "an optional field, whether to the display the volume to the end user or not.", - "length": 255, - "name": "displayvolume", - "required": false, - "type": "boolean" - }, { "description": "the ID of the disk volume", "length": 255, @@ -59066,11 +59670,18 @@ "type": "uuid" }, { - "description": "new name of the volume", + "description": "an optional field, whether to the display the volume to the end user or not.", "length": 255, - "name": "name", + "name": "displayvolume", "required": false, - "since": "4.16", + "type": "boolean" + }, + { + "description": "The state of the volume", + "length": 255, + "name": "state", + "required": false, + "since": "4.3", "type": "string" }, { @@ -59082,199 +59693,240 @@ "type": "string" }, { - "description": "Destination storage pool UUID for the volume", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "customid", "required": false, - "since": "4.3", - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "The path of the volume", + "description": "new name of the volume", "length": 255, - "name": "path", + "name": "name", "required": false, + "since": "4.16", "type": "string" }, { - "description": "The state of the volume", + "description": "Destination storage pool UUID for the volume", "length": 255, - "name": "state", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, "since": "4.3", - "type": "string" + "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "The path of the volume", "length": 255, - "name": "customid", + "name": "path", "required": false, - "since": "4.4", "type": "string" } ], "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ - {}, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the 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": "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": "cluster id of the volume", - "name": "clusterid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "id of the 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 project name of the vpn", - "name": "project", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { @@ -59283,48 +59935,44 @@ "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, + {}, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { @@ -59333,182 +59981,145 @@ "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "pod name of the volume", + "name": "podname", + "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 read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, - {}, { - "description": "the status of the volume", - "name": "status", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, + {}, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, { "description": "the ID of the 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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" } ] }, @@ -59517,13 +60128,6 @@ "isasync": false, "name": "listTrafficTypes", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -59531,6 +60135,14 @@ "required": false, "type": "string" }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, @@ -59539,46 +60151,50 @@ "type": "integer" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" } ], "related": "listNetworkServiceProviders", "response": [ - {}, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, { - "description": "the provider name", - "name": "name", + "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": "uuid of the network provider", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -59587,14 +60203,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "state of the network provider", + "name": "state", + "type": "string" } ], "since": "3.0.0" @@ -59629,13 +60240,6 @@ ], "related": "updateProjectRole", "response": [ - {}, - {}, - { - "description": "the ID of the role", - "name": "id", - "type": "string" - }, { "description": "the id of the project", "name": "projectid", @@ -59646,21 +60250,28 @@ "name": "name", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the description of the role", + "name": "description", + "type": "string" }, + {}, { "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", "name": "ispublic", @@ -59670,358 +60281,174 @@ "since": "4.15.0" }, { - "description": "Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC)", - "isasync": true, - "name": "createIpv6FirewallRule", + "description": "Updates account information for the authenticated user", + "isasync": false, + "name": "updateAccount", "params": [ { - "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", - "length": 255, - "name": "traffictype", - "required": false, - "type": "string" - }, - { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "Details for the account used to store specific parameters", "length": 255, - "name": "destcidrlist", + "name": "accountdetails", "required": false, - "type": "list" + "type": "map" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "Current account name", "length": 255, - "name": "startport", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "Account UUID", "length": 255, - "name": "cidrlist", + "name": "id", + "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the ending port of Ipv6 firewall rule", + "description": "New name for the account", "length": 255, - "name": "endport", + "name": "newname", "required": false, - "type": "integer" + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "The UUID of the dynamic role to set for the account", "length": 255, - "name": "fordisplay", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "error code for this ICMP message", + "description": "The UUID of the domain where the account exists", "length": 255, - "name": "icmpcode", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "integer" - }, - { - "description": "The network of the VM the Ipv6 firewall rule will be created for", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, "type": "uuid" }, { - "description": "type of the ICMP message being sent", + "description": "Network domain for the account's networks; empty string will update domainName with NULL value", "length": 255, - "name": "icmptype", + "name": "networkdomain", "required": false, - "type": "integer" + "type": "string" } ], - "related": "updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", + "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", "response": [ { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - {}, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "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 ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the state of the rule", - "name": "state", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "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 VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, {}, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the 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": "Updates account information for the authenticated user", - "isasync": false, - "name": "updateAccount", - "params": [ - { - "description": "The UUID of the dynamic role to set for the account", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" - }, - { - "description": "Details for the account used to store specific parameters", - "length": 255, + "description": "details for the account", "name": "accountdetails", - "required": false, "type": "map" }, { - "description": "Network domain for the account's networks; empty string will update domainName with NULL value", - "length": 255, + "description": "the network domain", "name": "networkdomain", - "required": false, - "type": "string" - }, - { - "description": "Account UUID", - "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - }, - { - "description": "The UUID of the domain where the account exists", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "New name for the account", - "length": 255, - "name": "newname", - "required": false, - "type": "string" - }, - { - "description": "Current account name", - "length": 255, - "name": "account", - "required": false, "type": "string" - } - ], - "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", - "response": [ - { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the id of the account", - "name": "id", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { "description": "the total number of templates which can be created by this account", "name": "templatelimit", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { @@ -60030,45 +60457,39 @@ "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, - {}, { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { "description": "true if the account requires cleanup", @@ -60076,74 +60497,43 @@ "type": "boolean" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "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", + "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 total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, - {}, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "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 account", - "name": "snapshotavailable", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { @@ -60151,9 +60541,9 @@ "name": "user", "response": [ { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "the type of the role", @@ -60161,30 +60551,25 @@ "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the api key of the user", + "name": "apikey", "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", + "description": "the user ID", + "name": "id", "type": "string" }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, { "description": "the boolean value representing if the updating target is in caller's child domain", "name": "iscallerchilddomain", @@ -60196,8 +60581,8 @@ "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { @@ -60205,49 +60590,49 @@ "name": "isdefault", "type": "boolean" }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the user firstname", - "name": "firstname", + "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 user name", - "name": "username", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -60256,67 +60641,57 @@ "type": "boolean" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "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 name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" } ], "type": "list" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "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", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { "description": "the name of the account", @@ -60324,68 +60699,74 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, + {}, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "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", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" } ] @@ -60395,6 +60776,13 @@ "isasync": false, "name": "addSecondaryStorage", "params": [ + { + "description": "the URL for the secondary storage", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, { "description": "the Zone ID for the secondary storage", "length": 255, @@ -60402,27 +60790,20 @@ "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" - }, - { - "description": "the URL for the secondary storage", - "length": 255, - "name": "url", - "required": true, - "type": "string" } ], "related": "listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, {}, { "description": "the name of the image store", @@ -60430,13 +60811,18 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the url of the image store", + "name": "url", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the image store", + "name": "id", "type": "string" }, { @@ -60445,40 +60831,35 @@ "type": "boolean" }, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, + {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the url of the image store", - "name": "url", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - {}, { "description": "the Zone name of the image store", "name": "zonename", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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 protocol of the image store", @@ -60492,13 +60873,6 @@ "isasync": false, "name": "updateVirtualMachine", "params": [ - { - "description": "user generated name", - "length": 255, - "name": "displayname", - "required": false, - "type": "string" - }, { "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", "length": 5120, @@ -60508,27 +60882,29 @@ "type": "string" }, { - "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", - "length": 255, - "name": "name", + "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.4", + "since": "4.16.0", "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the ID of the OS type that best represents this VM.", "length": 255, - "name": "customid", + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "description": "the ID of the userdata", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "userdataid", + "related": "", "required": false, - "type": "map" + "since": "4.18", + "type": "uuid" }, { "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", @@ -60538,33 +60914,56 @@ "type": "map" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "displayvm", + "name": "customid", "required": false, - "type": "boolean" + "since": "4.4", + "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": "list of security group ids to be applied on the virtual machine.", "length": 255, - "name": "cleanupdetails", + "name": "securitygroupids", + "related": "createSecurityGroup", + "required": false, + "type": "list" + }, + { + "description": "true if high-availability is enabled for the virtual machine, false otherwise", + "length": 255, + "name": "haenable", "required": false, "type": "boolean" }, { - "description": "group of the virtual machine", + "description": "user generated name", "length": 255, - "name": "group", + "name": "displayname", "required": false, "type": "string" }, { - "description": "the ID of the userdata", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "userdataid", - "related": "", + "name": "displayvm", "required": false, - "since": "4.18", + "type": "boolean" + }, + { + "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", + "length": 255, + "name": "name", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, "type": "uuid" }, { @@ -60576,27 +60975,18 @@ "type": "map" }, { - "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": "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": "isdynamicallyscalable", + "name": "cleanupdetails", "required": false, "type": "boolean" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, - "since": "4.16.0", - "type": "string" - }, - { - "description": "the ID of the OS type that best represents this VM.", + "description": "group of the virtual machine", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "group", "required": false, - "type": "uuid" + "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", @@ -60606,6 +60996,13 @@ "required": false, "type": "list" }, + { + "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "length": 255, + "name": "dhcpoptionsnetworklist", + "required": false, + "type": "map" + }, { "description": "instance name of the user vm", "length": 255, @@ -60615,110 +61012,68 @@ "type": "string" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "true if high-availability is enabled for the virtual machine, false otherwise", + "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": "haenable", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" - }, - { - "description": "list of security group ids to be applied on the virtual machine.", - "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", - "required": false, - "type": "list" } ], "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - {}, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { "description": "the ID of the corresponding network", @@ -60731,34 +61086,24 @@ "type": "integer" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { "description": "the broadcast uri of the nic", @@ -60766,18 +61111,18 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -60786,43 +61131,38 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -60830,37 +61170,42 @@ "name": "ipaddresses", "type": "list" }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, { "description": "the isolation uri of the nic", "name": "isolationuri", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" } ], "type": "set" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { @@ -60869,66 +61214,111 @@ "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, { "description": "the control state of the host for the virtual machine", "name": "hostcontrolstate", "type": "string" }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, { "description": "the name of the security group", "name": "name", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the 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", + "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -60937,13 +61327,8 @@ "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -60951,14 +61336,24 @@ "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 ending IP of the security group rule ", - "name": "endport", + "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" }, { @@ -60966,33 +61361,33 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -61006,8 +61401,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -61022,108 +61417,81 @@ "type": "set" }, { - "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 project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the 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 account associated with the tag", "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -61136,242 +61504,381 @@ "name": "project", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "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" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the account owning the security group", + "name": "account", + "type": "string" } ], "type": "set" }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, { "description": "ssh key-pairs", "name": "keypairs", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + {}, + { + "description": "the project name of the vm", + "name": "project", + "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 account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project name where tag belongs to", + "description": "the project name of the affinity group", "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" } ], "type": "set" }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, { "description": "device ID of the root volume", "name": "rootdeviceid", "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, - {}, { - "description": "the 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 date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { "description": "the vGPU type used by the virtual machine", @@ -61379,296 +61886,400 @@ "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + {}, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, + {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "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" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "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 group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "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 type of the template for the virtual machine", - "name": "templatetype", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + } + ] + }, + { + "description": "Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC)", + "isasync": true, + "name": "createIpv6FirewallRule", + "params": [ + { + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the ending port of Ipv6 firewall rule", + "length": 255, + "name": "endport", + "required": false, "type": "integer" }, { - "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 name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "The network of the VM the Ipv6 firewall rule will be created for", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "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": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" + }, + { + "description": "the starting port of Ipv6 firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" + }, + { + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "destcidrlist", + "required": false, + "type": "list" + } + ], + "related": "listPortForwardingRules,updatePortForwardingRule,updateIpv6FirewallRule", + "response": [ + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "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 public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, - {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "tag key name", + "name": "key", "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 description of the affinity group", - "name": "description", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the state of the rule", + "name": "state", "type": "string" } ] @@ -61689,15 +62300,20 @@ ], "related": "prepareForShutdown", "response": [ + { + "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 id of the management server", - "name": "managementserverid", - "type": "long" + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -61705,22 +62321,17 @@ "type": "integer" }, {}, - {}, { "description": "The number of jobs in progress", "name": "pendingjobscount", "type": "long" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" + "description": "The id of the management server", + "name": "managementserverid", + "type": "long" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.19.0" }, @@ -61737,13 +62348,6 @@ "required": false, "type": "uuid" }, - { - "description": "Disables specified account.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "Disables specified account in this domain.", "length": 255, @@ -61752,6 +62356,13 @@ "required": false, "type": "uuid" }, + { + "description": "Disables specified account.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "If true, only lock the account; else disable the account", "length": 255, @@ -61763,39 +62374,29 @@ "related": "createAccount,enableAccount,listAccounts,listAccounts", "response": [ { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { "description": "the state of the account", @@ -61803,105 +62404,89 @@ "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", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, { "description": "true if account is default, false otherwise", "name": "isdefault", "type": "boolean" }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, { "description": "the total number of networks owned by account", "name": "networktotal", "type": "long" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { "description": "the default zone of the account", @@ -61909,93 +62494,75 @@ "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the id of the account", - "name": "id", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" }, + {}, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "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 account", + "name": "volumelimit", "type": "string" }, + {}, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the user state", - "name": "state", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { "description": "the source type of the user in lowercase, such as native, ldap, saml2", @@ -62008,13 +62575,13 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { @@ -62023,8 +62590,13 @@ "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { @@ -62033,108 +62605,132 @@ "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the api key of the user", + "name": "apikey", "type": "string" } ], "type": "list" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" }, - {}, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "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", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -62142,53 +62738,68 @@ "type": "string" }, { - "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": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the name of the account", - "name": "name", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "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 name of the role", - "name": "rolename", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" } ] @@ -62199,11 +62810,11 @@ "name": "listDomains", "params": [ { - "description": "", + "description": "List domain by domain name.", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", @@ -62213,19 +62824,18 @@ "type": "boolean" }, { - "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", + "description": "", "length": 255, - "name": "details", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" }, { - "description": "List domain by domain ID.", + "description": "", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "flag to display the resource icon for domains", @@ -62235,30 +62845,31 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "List domain by domain ID.", "length": 255, - "name": "keyword", + "name": "id", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List domains by domain level.", + "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "level", + "name": "details", "required": false, - "type": "integer" + "type": "list" }, { - "description": "List domain by domain name.", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "List domains by domain level.", "length": 255, - "name": "pagesize", + "name": "level", "required": false, "type": "integer" } @@ -62266,13 +62877,13 @@ "related": "listDomainChildren,listDomains", "response": [ { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { @@ -62280,60 +62891,55 @@ "name": "networklimit", "type": "string" }, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { @@ -62341,135 +62947,140 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the name of the domain", - "name": "name", - "type": "string" - }, - { - "description": "the date when this domain was created", - "name": "created", - "type": "date" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, + {}, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "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", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, - {}, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the state of the domain", - "name": "state", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { "description": "the domain name of the parent domain", "name": "parentdomainname", "type": "string" }, + { + "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 total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { @@ -62478,49 +63089,49 @@ "type": "long" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the ID of the domain", + "name": "id", + "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "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 domain", - "name": "networkavailable", - "type": "string" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" } ] }, @@ -62530,34 +63141,26 @@ "name": "updateNetwork", "params": [ { - "description": "the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", + "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", "length": 255, - "name": "dns1", + "name": "ip6dns2", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "privatemtu", - "required": false, - "since": "4.18.0", - "type": "integer" - }, - { - "description": "the new display text for the network", + "description": "network domain", "length": 255, - "name": "displaytext", + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "guestvmcidr", + "name": "displaynetwork", "required": false, - "type": "string" + "type": "boolean" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -62576,11 +63179,33 @@ "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", + "description": "network offering ID", "length": 255, - "name": "sourcenatipaddress", + "name": "networkofferingid", + "related": "listNetworkOfferings", "required": false, - "since": "4.19", + "type": "uuid" + }, + { + "description": "the new name for the network", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "Force update even if CIDR type is different", + "length": 255, + "name": "changecidr", + "required": false, + "type": "boolean" + }, + { + "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" }, { @@ -62592,26 +63217,26 @@ "type": "integer" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "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": "displaynetwork", + "name": "sourcenatipaddress", "required": false, - "type": "boolean" + "since": "4.19", + "type": "string" }, { - "description": "network domain", + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", "length": 255, - "name": "networkdomain", + "name": "hideipaddressusage", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "network offering ID", + "description": "the new display text for the network", "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the ID of the network", @@ -62622,73 +63247,59 @@ "type": "uuid" }, { - "description": "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", + "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", "length": 255, - "name": "ip6dns1", + "name": "guestvmcidr", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "Force update even if CIDR type is different", - "length": 255, - "name": "changecidr", - "required": false, - "type": "boolean" - }, - { - "description": "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider", - "length": 255, - "name": "updateinsequence", - "required": false, - "type": "boolean" - }, - { - "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", + "description": "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", "length": 255, - "name": "ip6dns2", + "name": "ip6dns1", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "the new name for the network", + "description": "Setting this to true will cause a forced network update,", "length": 255, - "name": "name", + "name": "forced", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "hideipaddressusage", + "name": "privatemtu", "required": false, - "type": "boolean" + "since": "4.18.0", + "type": "integer" }, { - "description": "Setting this to true will cause a forced network update,", + "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": "forced", + "name": "updateinsequence", "required": false, "type": "boolean" } ], "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "response": [ - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, { "description": "The internet protocol of network offering", "name": "internetprotocol", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { "description": "true if guest network default egress policy is allow; false if default egress policy is deny", @@ -62696,13 +63307,13 @@ "type": "boolean" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { @@ -62711,113 +63322,92 @@ "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "the owner of the network", - "name": "account", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "the project name of the address", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, + {}, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, { "description": "the list of services", "name": "service", "response": [ { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { @@ -62825,19 +63415,14 @@ "name": "state", "type": "string" }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, { "description": "uuid of the network provider", "name": "id", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -62847,79 +63432,116 @@ } ], "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": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "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": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { "description": "the date this network was created", @@ -62927,33 +63549,33 @@ "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { @@ -62962,25 +63584,14 @@ "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - {}, - { - "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": "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 name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" }, { "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", @@ -62988,69 +63599,83 @@ "type": "set" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, - {}, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "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 can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { @@ -63058,13 +63683,13 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -63073,106 +63698,92 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the name of the network", - "name": "name", - "type": "string" - }, - { - "description": "The routing mode of network offering", - "name": "ip6routing", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, + {}, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the type of the network", - "name": "type", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "state of the network", + "name": "state", "type": "string" } ] @@ -63190,12 +63801,6 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "usage type", - "name": "usagetypeid", - "type": "integer" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -63205,7 +63810,13 @@ "description": "description of usage type", "name": "description", "type": "string" - } + }, + { + "description": "usage type", + "name": "usagetypeid", + "type": "integer" + }, + {} ] }, { @@ -63214,11 +63825,27 @@ "name": "resetUserDataForVirtualMachine", "params": [ { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "The ID of the virtual machine", "length": 255, - "name": "account", + "name": "id", + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the userdata", + "length": 255, + "name": "userdataid", + "related": "", "required": false, - "type": "string" + "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", @@ -63244,27 +63871,11 @@ "type": "uuid" }, { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "type": "map" - }, - { - "description": "the ID of the userdata", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "userdataid", - "related": "", + "name": "account", "required": false, - "type": "uuid" - }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "type": "string" } ], "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", @@ -63275,453 +63886,58 @@ "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "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 pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { "description": "device ID of the root volume", "name": "rootdeviceid", "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - {}, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the 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": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { @@ -63729,71 +63945,123 @@ "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 ingress rules associated with the security group", - "name": "ingressrule", + "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": "account owning the security group rule", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of 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": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -63802,13 +64070,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -63817,96 +64085,64 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "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 resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "tag value", - "name": "value", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "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 name of the security group", - "name": "domain", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { @@ -63914,48 +64150,48 @@ "name": "account", "type": "string" }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, { "description": "the project name of the group", "name": "project", "type": "string" }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -63963,13 +64199,8 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -63977,24 +64208,19 @@ "name": "resourceid", "type": "string" }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -64003,38 +64229,33 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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 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", @@ -64044,26 +64265,46 @@ "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", + "description": "the ID of the security group", + "name": "id", "type": "string" } ], "type": "set" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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 id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { @@ -64071,40 +64312,143 @@ "name": "vgpu", "type": "string" }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + {}, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, { "description": "the memory used by the VM in KiB", "name": "memorykbs", "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the 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 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 control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "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": "true if high-availability is enabled, false otherwise", @@ -64112,58 +64456,93 @@ "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, { "description": "device type of the root volume", "name": "rootdevicetype", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { @@ -64171,18 +64550,18 @@ "name": "affinitygroup", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { @@ -64191,18 +64570,23 @@ "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "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", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -64211,21 +64595,67 @@ "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" } ], "type": "set" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the ID of the 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 amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + {}, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "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 user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { @@ -64234,71 +64664,252 @@ "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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 project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, - {}, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, { "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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 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 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 gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "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": "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the 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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "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": "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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" } ], "since": "4.18.0" @@ -64308,14 +64919,6 @@ "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": "the ID of the template", "length": 255, @@ -64331,6 +64934,14 @@ "required": false, "since": "4.9+", "type": "boolean" + }, + { + "description": "the ID of zone of the template", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" } ], "response": [ @@ -64340,22 +64951,22 @@ "type": "string" }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -64364,49 +64975,51 @@ "name": "listNetworkACLLists", "params": [ { - "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": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "list network ACLs by VPC ID", + "description": "list network ACLs by network ID", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "list network ACLs by VPC ID", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Lists network ACL with the specified ID.", "length": 255, - "name": "fordisplay", + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -64423,27 +65036,18 @@ "type": "boolean" }, { - "description": "Lists network ACL with the specified ID.", - "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "required": false, - "type": "uuid" - }, - { - "description": "list network ACLs by network ID", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -64459,23 +65063,40 @@ "name": "name", "required": false, "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "createNetworkACLList", "response": [ { - "description": "the Name of the ACL", - "name": "name", + "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": "the ID of the ACL", "name": "id", "type": "string" }, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the Name of the ACL", + "name": "name", "type": "string" }, { @@ -64489,22 +65110,12 @@ "type": "string" }, { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", + "type": "string" }, {}, - {}, - { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", - "type": "string" - } + {} ] }, { @@ -64523,90 +65134,59 @@ ], "related": "copySnapshot,revertSnapshot,listSnapshots", "response": [ - { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - {}, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, { "description": "id of the os on volume", "name": "ostypeid", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, - { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" - }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the status of the template", - "name": "status", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", "type": "long" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" - }, - { - "description": "name of the snapshot", - "name": "name", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { @@ -64615,19 +65195,8 @@ "type": "integer" }, { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" - }, - {}, - { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { @@ -64635,8 +65204,8 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -64645,18 +65214,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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" }, { @@ -64665,76 +65234,118 @@ "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 ID of the domain associated with the tag", + "name": "domainid", "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": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, + {}, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + {}, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, { "description": "ID of the datastore for the snapshot entry", "name": "datastoreid", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" } ] @@ -64754,28 +65365,28 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, + { + "description": "the UUID of the latest async job acting on 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" - } + }, + {}, + {} ] }, { @@ -64783,14 +65394,6 @@ "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": "id of customer gateway", "length": 255, @@ -64799,6 +65402,14 @@ "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, @@ -64811,8 +65422,8 @@ "related": "createVpnGateway,listVpnGateways", "response": [ { - "description": "the project id", - "name": "projectid", + "description": "the owner", + "name": "account", "type": "string" }, { @@ -64820,35 +65431,30 @@ "name": "publicip", "type": "string" }, - {}, - { - "description": "the vpc id of this gateway", - "name": "vpcid", - "type": "string" - }, { - "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": "is vpn gateway for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -64856,25 +65462,30 @@ "name": "domainid", "type": "string" }, - {}, + { + "description": "the vpc id of this gateway", + "name": "vpcid", + "type": "string" + }, { "description": "the vpc name of this gateway", "name": "vpcname", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the project name", + "name": "project", "type": "string" }, + {}, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vpn gateway ID", + "name": "id", "type": "string" } ], @@ -64895,27 +65506,27 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {} ] }, @@ -64931,14 +65542,6 @@ "required": false, "type": "string" }, - { - "description": "The ID of the security group. Mutually exclusive with name parameter", - "length": 255, - "name": "id", - "related": "createSecurityGroup", - "required": false, - "type": "uuid" - }, { "description": "the domain ID of account owning the security group", "length": 255, @@ -64961,20 +65564,24 @@ "name": "account", "required": false, "type": "string" + }, + { + "description": "The ID of the security group. Mutually exclusive with name parameter", + "length": 255, + "name": "id", + "related": "createSecurityGroup", + "required": false, + "type": "uuid" } ], "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -64985,7 +65592,11 @@ "name": "success", "type": "boolean" }, - {} + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -65001,14 +65612,6 @@ "since": "4.16.0", "type": "boolean" }, - { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, { "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", "length": 255, @@ -65021,82 +65624,297 @@ "description": "Destination Host ID to migrate VM to.", "length": 255, "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, "type": "uuid" + }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" } ], "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "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 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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the 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": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the 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 list of nics associated with vm", + "name": "nic", + "response": [ + { + "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 Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "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 ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "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": "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 nic", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { @@ -65105,121 +65923,228 @@ "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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 password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "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 project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, { "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", "name": "diskofferingname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the account associated with the tag", + "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "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" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the description of the affinity group", + "name": "description", "type": "string" } ], "type": "set" }, + {}, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { "description": "the name of the service offering of the virtual machine", @@ -65227,61 +66152,163 @@ "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "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 list of resource tags associated", + "name": "tags", "response": [ { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project 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" + } + ], + "type": "set" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the 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 ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the 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", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -65289,33 +66316,33 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "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": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -65324,124 +66351,146 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], "type": "set" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, { "description": "the ID of the security group", "name": "id", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "security group name", - "name": "securitygroupname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "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 list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "the project id the tag belongs to", "name": "projectid", @@ -65463,8 +66512,18 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -65473,575 +66532,127 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", "type": "string" }, { "description": "the domain ID of the security group", "name": "domainid", "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" } ], "type": "set" }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, { "description": "the name of the domain in which the virtual machine exists", "name": "domain", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "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 ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the 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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - {}, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the 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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the 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" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - {}, { "description": "Base64 string containing the user data", "name": "userdata", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -66050,14 +66661,14 @@ "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" } ] }, @@ -66082,17 +66693,70 @@ "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": "list baremetal rack configuration", + "isasync": false, + "name": "listBaremetalRct", + "params": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "addBaremetalRct", + "response": [ + { + "description": "id of rct", + "name": "id", "type": "string" }, {}, + {}, + { + "description": "url", + "name": "url", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -66105,6 +66769,20 @@ "isasync": true, "name": "createTemplate", "params": [ + { + "description": "The display text of the template, defaults to the 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" + }, { "description": "true if this template is a featured template, false otherwise", "length": 255, @@ -66113,13 +66791,20 @@ "type": "boolean" }, { - "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", + "description": "the ID of the OS Type that best represents the OS of this template.", "length": 255, - "name": "snapshotid", - "related": "copySnapshot,revertSnapshot,listSnapshots", - "required": false, + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", + "required": true, "type": "uuid" }, + { + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" + }, { "description": "true if the template requires HVM, false otherwise", "length": 255, @@ -66128,32 +66813,34 @@ "type": "boolean" }, { - "description": "the tag for this template.", + "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": "templatetag", + "name": "virtualmachineid", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", - "length": 2048, - "name": "url", + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", "required": false, "type": "string" }, { - "description": "true if the template supports the password reset feature; default is false", + "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": "passwordenabled", + "name": "snapshotid", + "related": "copySnapshot,revertSnapshot,listSnapshots", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", + "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", + "length": 2048, + "name": "url", "required": false, - "type": "boolean" + "type": "string" }, { "description": "an optional accountName. Must be used with domainId.", @@ -66171,40 +66858,25 @@ "type": "map" }, { - "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", + "description": "the name of the template", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "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", + "description": "create template for the project", "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" - }, - { - "description": "32 or 64 bit", - "length": 255, - "name": "bits", - "required": false, - "type": "integer" - }, - { - "description": "create template for the project", + "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": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "volumeid", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "type": "uuid" }, @@ -66218,25 +66890,18 @@ "type": "uuid" }, { - "description": "true if this template is a public template, false otherwise", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "ispublic", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "the name of the template", + "description": "true if this template is a public template, false otherwise", "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "The display text of the template, defaults to the 'name'.", - "length": 4096, - "name": "displaytext", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { "description": "an optional domainId. If the account parameter is used, domainId must also be used.", @@ -66248,44 +66913,38 @@ "type": "uuid" }, { - "description": "the ID of the OS Type that best represents the OS of this template.", + "description": "32 or 64 bit", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": true, - "type": "uuid" + "name": "bits", + "required": false, + "type": "integer" } ], "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "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": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { @@ -66294,29 +66953,34 @@ "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { "description": "the ID of the zone for this template", @@ -66324,115 +66988,68 @@ "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "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": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { @@ -66441,130 +67058,176 @@ "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the tag of this template", + "name": "templatetag", "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": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, - {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", + "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": "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": "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], "type": "set" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { "description": "Base64 string representation of the resource icon", @@ -66573,68 +67236,78 @@ }, {}, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "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 URL which the template/iso is registered from", + "name": "url", + "type": "string" } ] }, { - "description": "list baremetal rack configuration", - "isasync": false, - "name": "listBaremetalRct", + "description": "Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself.", + "isasync": true, + "name": "uploadCustomCertificate", "params": [ { - "description": "", + "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": "page", + "name": "id", "required": false, "type": "integer" }, { - "description": "", + "description": "DNS domain suffix that the certificate is granted for.", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "domainsuffix", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "A name / alias for the certificate.", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" - } - ], - "related": "addBaremetalRct", - "response": [ - { - "description": "url", - "name": "url", - "type": "string" }, - {}, { - "description": "id of rct", - "name": "id", + "description": "The private key for the attached certificate.", + "length": 65535, + "name": "privatekey", + "required": false, "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "description": "The certificate to be uploaded.", + "length": 65535, + "name": "certificate", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "message of the certificate upload operation", + "name": "message", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -66643,34 +67316,34 @@ "name": "listDedicatedClusters", "params": [ { - "description": "", + "description": "the ID of the domain associated with the cluster", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the cluster", + "description": "the name of the account associated with the cluster. Must be used with domainId.", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list dedicated clusters by affinity group", + "description": "the ID of the cluster", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -66680,17 +67353,17 @@ "type": "integer" }, { - "description": "the ID of the domain associated with the cluster", + "description": "list dedicated clusters by affinity group", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "affinitygroupid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the name of the account associated with the cluster. Must be used with domainId.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" } @@ -66698,18 +67371,13 @@ "related": "", "response": [ { - "description": "the name of the cluster", - "name": "clustername", - "type": "string" - }, - { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the Account ID of the cluster", + "name": "accountid", "type": "string" }, { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "the name of the cluster", + "name": "clustername", "type": "string" }, { @@ -66717,87 +67385,30 @@ "name": "domainid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the Dedication Affinity Group ID of the cluster", "name": "affinitygroupid", "type": "string" }, - {}, - { - "description": "the Account ID of the cluster", - "name": "accountid", - "type": "string" - } - ] - }, - { - "description": "Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself.", - "isasync": true, - "name": "uploadCustomCertificate", - "params": [ - { - "description": "An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3", - "length": 255, - "name": "id", - "required": false, - "type": "integer" - }, - { - "description": "The certificate to be uploaded.", - "length": 65535, - "name": "certificate", - "required": true, - "type": "string" - }, - { - "description": "A name / alias for the certificate.", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { - "description": "DNS domain suffix that the certificate is granted for.", - "length": 255, - "name": "domainsuffix", - "required": true, + "description": "the ID of the cluster", + "name": "clusterid", "type": "string" }, - { - "description": "The private key for the attached certificate.", - "length": 65535, - "name": "privatekey", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "message of the certificate upload operation", - "name": "message", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, {} @@ -66818,28 +67429,28 @@ ], "related": "", "response": [ - { - "description": "the CA service provider name", - "name": "name", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, + {}, { "description": "the description of the CA service provider", "name": "description", "type": "string" }, - {}, - {} + { + "description": "the CA service provider name", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.11.0" }, @@ -66858,29 +67469,56 @@ } ], "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "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": "Update quota calculations, alerts and statements", + "isasync": false, + "name": "quotaUpdate", + "params": [], + "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": "timestamp when the run got over", + "name": "updated_on", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } - ] + ], + "since": "4.7.0" }, { "description": "Lists all port forwarding rules for an IP address.", @@ -66888,28 +67526,26 @@ "name": "listPortForwardingRules", "params": [ { - "description": "List resources by tags (key/value pairs)", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "tags", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "description": "list port forwarding rules for certain network", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "pagesize", "required": false, - "since": "4.3", - "type": "uuid" + "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "fordisplay", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -66919,48 +67555,50 @@ "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of IP address of the port forwarding services", "length": 255, - "name": "isrecursive", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list port forwarding rules for certain network", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.3", "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "account", + "name": "id", + "related": "listPortForwardingRules,updatePortForwardingRule,updateIpv6FirewallRule", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of IP address of the port forwarding services", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "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" }, { @@ -66971,61 +67609,57 @@ "type": "string" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Lists rule with the specified ID.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" } ], - "related": "updateIpv6FirewallRule,updatePortForwardingRule", + "related": "updatePortForwardingRule,updateIpv6FirewallRule", "response": [ { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, + {}, { "description": "the starting port of port forwarding rule's private port range", "name": "privateport", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { @@ -67034,8 +67668,8 @@ "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" }, { @@ -67043,41 +67677,19 @@ "name": "fordisplay", "type": "boolean" }, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - {}, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, { "description": "the ending port of port forwarding rule's private port range", "name": "privateendport", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { @@ -67090,52 +67702,78 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" + }, + { + "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 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 public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" } ] }, @@ -67164,14 +67802,14 @@ "related": "", "response": [ { - "description": "the ID of the pod the IP address", - "name": "id", - "type": "long" + "description": "CIDR of the Pod", + "name": "cidr", + "type": "string" }, { - "description": "Gateway for Pod ", - "name": "gateway", - "type": "string" + "description": "the ID of the pod the IP address belongs to", + "name": "podid", + "type": "long" }, { "description": "the ID of the nic", @@ -67179,8 +67817,13 @@ "type": "long" }, { - "description": "the ID of the pod the IP address belongs to", - "name": "podid", + "description": "Gateway for Pod ", + "name": "gateway", + "type": "string" + }, + { + "description": "MAC address of the pod the IP", + "name": "hostmac", "type": "long" }, { @@ -67188,28 +67831,23 @@ "name": "jobid", "type": "string" }, + { + "description": "the ID of the pod the IP address", + "name": "id", + "type": "long" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "CIDR of the Pod", - "name": "cidr", - "type": "string" - }, - { - "description": "MAC address of the pod the IP", - "name": "hostmac", - "type": "long" - }, - {}, - {}, { "description": "Allocated IP address", "name": "ipaddress", "type": "string" - } + }, + {} ] }, { @@ -67228,31 +67866,24 @@ ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", "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 address", "name": "address", "type": "string" }, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, { "description": "the operation result", "name": "status", "type": "boolean" }, - {}, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - {}, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { @@ -67261,18 +67892,19 @@ "type": "string" }, { - "description": "the operation result description", - "name": "description", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, + {}, { "description": "true if out-of-band management is enabled for the host", "name": "enabled", "type": "boolean" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { @@ -67281,20 +67913,26 @@ "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "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 password", + "name": "password", + "type": "string" + }, + { + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" + }, + {} ], "since": "4.9.0" }, @@ -67303,14 +67941,6 @@ "isasync": false, "name": "listTungstenFabricNetwork", "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -67326,11 +67956,19 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { "description": "the uuid of Tungsten-Fabric network", @@ -67340,11 +67978,11 @@ "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" } ], "related": "", @@ -67354,32 +67992,32 @@ "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Tungsten-Fabric network name", "name": "name", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, - {}, - {}, { "description": "Tungsten-Fabric network uuid", "name": "uuid", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" } ] }, @@ -67389,12 +68027,18 @@ "name": "updateTemplatePermissions", "params": [ { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "isextractable", "required": false, - "type": "list" + "type": "boolean" + }, + { + "description": "permission operator (add, remove, reset)", + "length": 255, + "name": "op", + "required": false, + "type": "string" }, { "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", @@ -67403,6 +68047,14 @@ "required": false, "type": "list" }, + { + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "projectids", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "list" + }, { "description": "the template ID", "length": 255, @@ -67418,20 +68070,6 @@ "required": false, "type": "boolean" }, - { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" - }, - { - "description": "permission operator (add, remove, reset)", - "length": 255, - "name": "op", - "required": false, - "type": "string" - }, { "description": "true for featured template/iso, false otherwise", "length": 255, @@ -67442,9 +68080,9 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "any text associated with the success or failure", @@ -67458,9 +68096,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} ] @@ -67470,6 +68108,13 @@ "isasync": false, "name": "listTrafficMonitors", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "zone Id", "length": 255, @@ -67491,53 +68136,46 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "addTrafficMonitor", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the ID of the external firewall", "name": "id", "type": "string" }, - { - "description": "the zone ID of the external firewall", - "name": "zoneid", - "type": "string" - }, { "description": "the management IP address of the external firewall", "name": "ipaddress", "type": "string" }, + {}, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "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" } ] }, @@ -67546,14 +68184,6 @@ "isasync": true, "name": "resetPasswordForVirtualMachine", "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, { "description": "The new password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, @@ -67561,39 +68191,94 @@ "required": false, "since": "4.19.0", "type": "string" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" } ], "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", @@ -67601,136 +68286,232 @@ "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, { "description": "ssh key-pairs", "name": "keypairs", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "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": "the project id of the group", - "name": "projectid", + "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 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" }, { - "description": "the project name of the group", + "description": "the project name of the affinity group", "name": "project", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the ID of the security group", + "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 description of the security group", + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the affinity group", "name": "description", "type": "string" }, { - "description": "the account owning the security group", + "description": "the account owning the affinity group", "name": "account", "type": "string" }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "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 list of egress rules associated with the security group", "name": "egressrule", @@ -67740,58 +68521,43 @@ "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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" }, { @@ -67800,8 +68566,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -67810,53 +68576,98 @@ "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" } ], "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", "type": "string" }, { "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -67865,8 +68676,8 @@ "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -67874,48 +68685,28 @@ "name": "securitygroupname", "type": "string" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "resource type", - "name": "resourcetype", - "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -67929,13 +68720,18 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -67944,8 +68740,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], @@ -67955,22 +68751,124 @@ "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, { "description": "the name of the security group", "name": "name", "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the 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 vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { "description": "the virtual network for the service offering", @@ -67978,18 +68876,134 @@ "type": "boolean" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + {}, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { @@ -68002,59 +69016,59 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "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 VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "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 name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Type of adapter if available", + "name": "adaptertype", "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 broadcast uri of the nic", @@ -68062,18 +69076,18 @@ "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -68081,11 +69095,6 @@ "name": "mtu", "type": "integer" }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, { "description": "the traffic type of the nic", "name": "traffictype", @@ -68096,181 +69105,99 @@ "name": "isolatedpvlan", "type": "integer" }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "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 type of the nic", "name": "type", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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" - } - ], - "type": "set" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], "type": "set" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "Base64 string containing the user data", + "name": "userdata", "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 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": "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", @@ -68278,591 +69205,386 @@ "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "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 private end port of the port forwarding rule", + "length": 255, + "name": "privateendport", + "required": false, + "type": "integer" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the private start port of the port forwarding rule", + "length": 255, + "name": "privateport", + "required": false, + "type": "integer" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "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,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "VM guest nic Secondary ip address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, + "since": "4.5", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "the ID of the port forwarding rule", + "length": 255, + "name": "id", + "related": "updatePortForwardingRule,updateIpv6FirewallRule", + "required": true, + "since": "4.4", + "type": "uuid" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "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": "updateIpv6FirewallRule", + "response": [ { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, + {}, { - "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 ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the name of the 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 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 name of the template for the virtual machine", - "name": "templatename", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the account associated with the tag", + "name": "account", + "type": "string" } ], - "type": "set" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "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" - }, + "type": "list" + } + ] + }, + { + "description": "Lists Brocade VCS Switches", + "isasync": false, + "name": "listBrocadeVcsDevices", + "params": [ { - "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, - {}, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Brocade VCS switch ID", + "length": 255, + "name": "vcsdeviceid", + "related": "listBrocadeVcsDevices", + "required": false, + "type": "uuid" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, + } + ], + "related": "", + "response": [ { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "device name", + "name": "brocadedevicename", "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": "the state of the virtual machine", - "name": "state", + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "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 service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the principal switch Ip address", + "name": "hostname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", - "isasync": true, - "name": "updatePortForwardingRule", + "description": "link an existing cloudstack domain to group or OU in ldap", + "isasync": false, + "name": "linkDomainToLdap", "params": [ { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "name of the group or OU in LDAP", "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the port forwarding rule", + "description": "domain admin username in LDAP ", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule,updatePortForwardingRule", - "required": true, - "since": "4.4", - "type": "uuid" + "name": "admin", + "required": false, + "type": "string" }, { - "description": "the private start port of the port forwarding rule", + "description": "type of the ldap name. GROUP or OU", "length": 255, - "name": "privateport", - "required": false, - "type": "integer" + "name": "type", + "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": "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": "VM guest nic Secondary ip address for the port forwarding rule", - "length": 255, - "name": "vmguestip", - "required": false, - "since": "4.5", - "type": "string" - }, - { - "description": "the private end port of the port forwarding rule", + "description": "name of the group or OU in LDAP", "length": 255, - "name": "privateendport", + "name": "ldapdomain", "required": false, - "type": "integer" - } - ], - "related": "updateIpv6FirewallRule", - "response": [ - {}, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the 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 for the port forwarding rule", - "name": "ipaddress", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - } - ] - }, - { - "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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the Physical Network ID", + "description": "The id of the domain which has to be linked to LDAP.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": true, "type": "uuid" }, { - "description": "", + "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", "length": 255, - "name": "pagesize", - "required": false, + "name": "accounttype", + "required": true, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], - "related": "", + "related": "linkAccountToLdap", "response": [ - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -68874,89 +69596,15 @@ "type": "integer" }, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", - "type": "string" - }, - { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "device name", - "name": "brocadedevicename", - "type": "string" - }, - {}, - { - "description": "the principal switch Ip address", - "name": "hostname", - "type": "string" - } - ] - }, - { - "description": "link an existing cloudstack domain to group or OU in ldap", - "isasync": false, - "name": "linkDomainToLdap", - "params": [ - { - "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", - "length": 255, - "name": "type", - "required": true, - "type": "string" - }, - { - "description": "name of the group or OU in LDAP", - "length": 255, + "description": "name of the group or OU in LDAP which is linked to the domain", "name": "name", - "required": false, "type": "string" }, - { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", - "length": 255, - "name": "accounttype", - "required": true, - "type": "integer" - }, - { - "description": "name of the group or OU in LDAP", - "length": 255, - "name": "ldapdomain", - "required": false, - "type": "string" - } - ], - "related": "linkAccountToLdap", - "response": [ { "description": "Type of the account to auto import", "name": "accounttype", "type": "int" }, - { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", - "type": "string" - }, { "description": "type of the name in LDAP which is linked to the domain", "name": "type", @@ -68964,31 +69612,21 @@ }, {}, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", + "description": "Domain Admin accountId that is created", + "name": "accountid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the Domain which is linked to LDAP", + "name": "domainid", "type": "string" }, { "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", - "type": "string" - }, - { - "description": "Domain Admin accountId that is created", - "name": "accountid", + "name": "ldapdomain", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + } ], "since": "4.6.0" }, @@ -68998,43 +69636,28 @@ "name": "associateIpAddress", "params": [ { - "description": "the ID of the domain to associate with this IP address", + "description": "the account to associate with this IP address", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Deploy VM for the project", + "description": "region ID from where portable IP is to be associated.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "regionid", + "related": "addRegion,listRegions", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the availability zone you want to acquire an public IP address from", + "description": "The network this IP address should be associated to.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, - { - "description": "the account to associate with this IP address", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", - "length": 255, - "name": "isportable", - "required": false, - "type": "boolean" - }, { "description": "the VPC you want the IP address to be associated with", "length": 255, @@ -69044,10 +69667,10 @@ "type": "uuid" }, { - "description": "The network this IP address should be associated to.", + "description": "the ID of the domain to associate with this IP address", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, @@ -69059,12 +69682,27 @@ "type": "string" }, { - "description": "region ID from where portable IP is to be associated.", + "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "isportable", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "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", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { "description": "an optional field, whether to the display the IP to the end user or not", @@ -69077,51 +69715,35 @@ ], "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ - { - "description": "public IP address", - "name": "ipaddress", - "type": "string" - }, - {}, { "description": "virtual machine id the ip address is assigned to", "name": "virtualmachineid", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "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 name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, + {}, { "description": "the name of the zone the public IP address belongs to", "name": "zonename", "type": "string" }, - { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", - "type": "string" - }, { "description": "is public IP portable across the zones", "name": "isportable", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { @@ -69130,43 +69752,13 @@ "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", - "type": "string" - }, - { - "description": "VPC id the ip belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { @@ -69175,23 +69767,8 @@ "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" - }, - { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, { @@ -69200,28 +69777,8 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" - }, - { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "public IP address id", + "name": "id", "type": "string" }, { @@ -69230,23 +69787,8 @@ "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { @@ -69254,8 +69796,8 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -69269,52 +69811,148 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "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" } ], "type": "list" }, { - "description": "public IP address id", - "name": "id", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain the public IP address is associated with", + "name": "domain", + "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": "public IP address", + "name": "ipaddress", + "type": "string" + }, + {}, + { + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "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": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", + "type": "string" + }, + { + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" + }, + { + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -69324,39 +69962,39 @@ "name": "getSolidFireVolumeAccessGroupIds", "params": [ { - "description": "Storage Pool UUID", + "description": "Cluster UUID", "length": 255, - "name": "storageid", + "name": "clusterid", "required": true, "type": "string" }, { - "description": "Cluster UUID", + "description": "Storage Pool UUID", "length": 255, - "name": "clusterid", + "name": "storageid", "required": true, "type": "string" } ], "related": "", "response": [ + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "SolidFire Volume Access Group Ids", "name": "solidFireVolumeAccessGroupIds", "type": "long[]" }, - {}, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -69365,12 +70003,11 @@ "name": "setupUserTwoFactorAuthentication", "params": [ { - "description": "optional: the id of the user for which 2FA has to be disabled", + "description": "Enabled by default, provide false to disable 2FA", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "enable", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "two factor authentication code", @@ -69380,29 +70017,30 @@ "type": "string" }, { - "description": "Enabled by default, provide false to disable 2FA", + "description": "optional: the id of the user for which 2FA has to be disabled", "length": 255, - "name": "enable", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, + {}, { "description": "the user ID", "name": "id", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "secret code that needs to be registered with authenticator", + "name": "secretcode", "type": "string" }, { @@ -69411,16 +70049,16 @@ "type": "integer" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user name", + "name": "username", "type": "string" }, + {}, { - "description": "secret code that needs to be registered with authenticator", - "name": "secretcode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.18.0" }, @@ -69439,11 +70077,9 @@ } ], "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" }, { @@ -69452,10 +70088,12 @@ "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", @@ -69469,16 +70107,30 @@ "name": "createNetworkACL", "params": [ { - "description": "the ending port of ACL", + "description": "The number of the ACL item, its ordering", "length": 255, - "name": "endport", + "name": "number", "required": false, "type": "integer" }, { - "description": "error code for this ICMP message", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "icmpcode", + "name": "reason", + "required": false, + "type": "string" + }, + { + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" + }, + { + "description": "the ending port of ACL", + "length": 255, + "name": "endport", "required": false, "type": "integer" }, @@ -69491,11 +70143,11 @@ "type": "uuid" }, { - "description": "A description indicating why the ACL rule is required.", + "description": "error code for this ICMP message", "length": 255, - "name": "reason", + "name": "icmpcode", "required": false, - "type": "string" + "type": "integer" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -69506,31 +70158,31 @@ "type": "boolean" }, { - "description": "The network of the VM the ACL will be created for", + "description": "type of the ICMP message being sent", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "icmptype", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "protocol", - "required": true, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "scl entry action, allow or deny", + "description": "The network of the VM the ACL will be created for", "length": 255, - "name": "action", + "name": "aclid", + "related": "createNetworkACLList", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", + "description": "scl entry action, allow or deny", "length": 255, - "name": "traffictype", + "name": "action", "required": false, "type": "string" }, @@ -69541,37 +70193,100 @@ "required": false, "type": "integer" }, - { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - }, { "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, "name": "cidrlist", "required": false, "type": "list" - }, - { - "description": "The number of the ACL item, its ordering", - "length": 255, - "name": "number", - "required": false, - "type": "integer" } ], "related": "updateNetworkACLItem,moveNetworkAclItem", "response": [ + { + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + { + "description": "the ID of the ACL Item", + "name": "id", + "type": "string" + }, + { + "description": "the protocol of the ACL", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" + }, + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the starting port of ACL's port range", + "name": "startport", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -69585,130 +70300,53 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the 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": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project 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 state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" - }, - { - "description": "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 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": "Action of ACL Item. Allow/Deny", "name": "action", "type": "string" - }, - { - "description": "the ID of the ACL Item", - "name": "id", - "type": "string" - }, - { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" - }, - { - "description": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" - }, - { - "description": "the name of the ACL this item belongs to", - "name": "aclname", - "type": "string" - }, - {}, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, - { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" - }, - {} + } ] }, { @@ -69717,26 +70355,27 @@ "name": "resetSSHKeyForVirtualMachine", "params": [ { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, - "name": "keypair", + "name": "account", "required": false, "type": "string" }, { - "description": "names of the ssh key pairs to be used to login to the virtual machine", + "description": "an optional project for the ssh key", "length": 255, - "name": "keypairs", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.17", - "type": "list" + "type": "uuid" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "names of the ssh key pairs to be used to login to the virtual machine", "length": 255, - "name": "account", + "name": "keypairs", "required": false, - "type": "string" + "since": "4.17", + "type": "list" }, { "description": "The ID of the virtual machine", @@ -69747,290 +70386,423 @@ "type": "uuid" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "keypair", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional project for the ssh key", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" } ], "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, { "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "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 ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "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" + } + ], + "type": "set" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "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": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "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 description of the affinity group", - "name": "description", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the 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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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 name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, + {}, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { "description": "the outgoing network traffic on the host in KiB", @@ -70038,94 +70810,195 @@ "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "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 speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the 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 AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the domain name of the security group", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "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 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 group", - "name": "project", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the description of the affinity group", + "name": "description", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "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", @@ -70136,43 +71009,33 @@ "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 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": "tag key name", "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -70181,13 +71044,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -70196,44 +71059,34 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { @@ -70246,71 +71099,101 @@ "name": "name", "type": "string" }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { "description": "the id of the security group rule", @@ -70323,18 +71206,8 @@ "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -70347,33 +71220,28 @@ "name": "securitygroupname", "type": "string" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -70382,222 +71250,169 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "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 name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "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" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" } ], "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" } ], "type": "set" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, - {}, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, - {}, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + {}, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { "description": "the total number of network traffic bytes sent", @@ -70605,196 +71420,19 @@ "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 name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "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 ID of the corresponding network", - "name": "networkid", - "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "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 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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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" - } - ], - "type": "set" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" } ] }, @@ -70804,32 +71442,39 @@ "name": "listVpnCustomerGateways", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "id of the customer gateway", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "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" }, @@ -70841,81 +71486,79 @@ "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": "", + "description": "id of the customer gateway", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" } ], "related": "createVpnCustomerGateway", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "IPsec policy of customer gateway", "name": "esppolicy", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, + {}, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", "type": "boolean" }, - {}, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { @@ -70924,69 +71567,64 @@ "type": "boolean" }, { - "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": "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": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", "type": "long" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the vpn gateway ID", + "name": "id", + "type": "string" }, - {}, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, + {}, { "description": "the date and time the host was removed", "name": "removed", "type": "date" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "name of the customer gateway", - "name": "name", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" } ] @@ -71003,6 +71641,14 @@ "required": true, "type": "string" }, + { + "description": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, { "description": "The starting IP address.", "length": 255, @@ -71016,38 +71662,30 @@ "name": "endip", "required": true, "type": "string" - }, - { - "description": "UUID of POD, where the IP range belongs to.", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" } ], "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ], "since": "4.11.0.0" @@ -71058,24 +71696,24 @@ "name": "addKubernetesSupportedVersion", "params": [ { - "description": "the name of the Kubernetes supported version", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false", + "description": "the minimum number of CPUs to be set with the Kubernetes version", "length": 255, - "name": "directdownload", - "required": false, - "since": "4.18.2", - "type": "boolean" + "name": "mincpunumber", + "required": true, + "type": "integer" }, { - "description": "the URL of the binaries ISO for Kubernetes supported version", + "description": "the name of the Kubernetes supported version", "length": 255, - "name": "url", + "name": "name", "required": false, "type": "string" }, @@ -71087,12 +71725,19 @@ "type": "string" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false", + "length": 255, + "name": "directdownload", + "required": false, + "since": "4.18.2", + "type": "boolean" }, { "description": "the minimum RAM size in MB to be set with the Kubernetes version", @@ -71102,107 +71747,100 @@ "type": "integer" }, { - "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 URL of the binaries ISO for Kubernetes supported version", "length": 255, - "name": "checksum", + "name": "url", "required": false, "type": "string" - }, - { - "description": "the minimum number of CPUs to be set with the Kubernetes version", - "length": 255, - "name": "mincpunumber", - "required": true, - "type": "integer" } ], "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", - "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 minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "the id of the Kubernetes supported version", + "name": "id", + "type": "string" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, + {}, + { + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, { "description": "Name of the Kubernetes supported version", "name": "name", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the minimum number of CPUs needed for the Kubernetes supported version", "name": "mincpunumber", "type": "integer" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", - "type": "string" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, - { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" - }, - {}, { "description": "the id of the zone in which Kubernetes supported version is available", "name": "zoneid", "type": "string" }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", + "type": "string" + }, + { + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, + { + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" + }, + {}, { "description": "the id of the binaries ISO for Kubernetes supported version", "name": "isoid", "type": "string" }, - {}, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" } ] @@ -71212,6 +71850,14 @@ "isasync": true, "name": "deleteKubernetesCluster", "params": [ + { + "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, { "description": "Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false", "length": 255, @@ -71227,17 +71873,15 @@ "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", "required": true, "type": "uuid" - }, - { - "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.19.0", - "type": "boolean" } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -71248,18 +71892,12 @@ "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" - } + {} ] }, { @@ -71267,13 +71905,6 @@ "isasync": true, "name": "createGlobalLoadBalancerRule", "params": [ - { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, - "type": "string" - }, { "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", "length": 255, @@ -71282,9 +71913,9 @@ "type": "string" }, { - "description": "name of the load balancer rule", + "description": "GSLB service type (tcp, udp, http)", "length": 255, - "name": "name", + "name": "gslbservicetype", "required": true, "type": "string" }, @@ -71302,14 +71933,6 @@ "required": false, "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 domain ID associated with the load balancer", "length": 255, @@ -71319,51 +71942,40 @@ "type": "uuid" }, { - "description": "GSLB service type (tcp, udp, http)", + "description": "domain name for the GSLB service.", "length": 255, - "name": "gslbservicetype", + "name": "gslbdomainname", "required": true, "type": "string" }, { - "description": "domain name for the GSLB service.", + "description": "name of the load balancer rule", "length": 255, - "name": "gslbdomainname", + "name": "name", "required": true, "type": "string" - } - ], - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", - "response": [ - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" }, { - "description": "global load balancer rule ID", - "name": "id", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", + "required": false, "type": "string" }, { - "description": "Region Id in which global load balancer is created", + "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 domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", - "type": "string" - }, + } + ], + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Region Id in which global load balancer is created", + "name": "regionid", "type": "integer" }, { @@ -71371,53 +71983,23 @@ "name": "domainid", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the description of the global load balancer rule", - "name": "description", - "type": "string" - }, - { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", - "type": "string" - }, - { - "description": "name of the global load balancer rule", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, { "description": "Load balancing method used for the global load balancer", "name": "gslblbmethod", "type": "string" }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, { "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { @@ -71426,13 +72008,8 @@ "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": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { @@ -71441,18 +72018,8 @@ "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { @@ -71461,18 +72028,18 @@ "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the public ip address", + "name": "publicip", + "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the public port", + "name": "publicport", "type": "string" }, { @@ -71480,33 +72047,28 @@ "name": "domain", "type": "string" }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -71515,8 +72077,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -71525,57 +72087,133 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, { "description": "the project name of the load balancer", "name": "project", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "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 state of the rule", "name": "state", "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" } ], "type": "list" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, { "description": "GSLB service type", "name": "gslbservicetype", "type": "string" }, - {} + { + "description": "the description of the global load balancer rule", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", + "type": "string" + }, + { + "description": "name of the global load balancer rule", + "name": "name", + "type": "string" + }, + {}, + { + "description": "global load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -71590,14 +72228,6 @@ "required": false, "type": "string" }, - { - "description": "the ID of the ISO for the virtual machine", - "length": 255, - "name": "isoid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "type": "uuid" - }, { "description": "the ID of the template for the virtual machine", "length": 255, @@ -71613,29 +72243,47 @@ "related": "", "required": false, "type": "uuid" + }, + { + "description": "the ID of the ISO for the virtual machine", + "length": 255, + "name": "isoid", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" } ], "related": "listIsos,registerIso,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": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", "type": "map" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { "description": "the tag of this template", @@ -71643,247 +72291,222 @@ "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, + {}, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the template ID", - "name": "id", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "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 processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the template name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "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": "the URL which the template/iso is registered from", - "name": "url", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the project name of the template", - "name": "project", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, - {}, { - "description": "the status of the template", - "name": "status", + "description": "the template ID", + "name": "id", "type": "string" }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, { "description": "true if the ISO is bootable, false otherwise", "name": "bootable", "type": "boolean" }, - {}, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the template name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag 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": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag 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": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "the 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", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { @@ -71891,20 +72514,30 @@ "name": "isextractable", "type": "boolean" }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, { "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", "name": "userdataparams", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { "description": "if Datadisk template, then id of the root disk template this template belongs to", @@ -71912,34 +72545,39 @@ "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" } ], "since": "4.18.0" @@ -71964,17 +72602,17 @@ "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -71989,34 +72627,27 @@ "name": "listGlobalLoadBalancerRules", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the global load balancer rule", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "region ID", "length": 255, - "name": "page", + "name": "regionid", + "related": "addRegion,listRegions", "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, @@ -72026,12 +72657,18 @@ "type": "uuid" }, { - "description": "region ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "tags", "required": false, - "type": "integer" + "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": "list only resources belonging to the domain specified", @@ -72042,50 +72679,40 @@ "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "account", + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "required": false, - "type": "string" + "type": "uuid" } ], "related": "updateGlobalLoadBalancerRule", "response": [ - {}, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -72093,59 +72720,14 @@ "name": "name", "type": "string" }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, {}, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, { "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { @@ -72154,23 +72736,13 @@ "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", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { @@ -72178,66 +72750,86 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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": "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": "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 domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "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 public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -72245,113 +72837,120 @@ "name": "account", "type": "string" }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, { "description": "the state of the rule", "name": "state", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the 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 protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "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": "the description of the global load balancer rule", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the project name of the load balancer", + "name": "project", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, + {}, { "description": "GSLB service type", "name": "gslbservicetype", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, { - "description": "global load balancer rule ID", - "name": "id", + "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": "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - {} + } ] }, { @@ -72369,7 +72968,11 @@ } ], "response": [ - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -72381,16 +72984,12 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -72399,16 +72998,17 @@ "name": "listTags", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list by key", + "description": "list by customer name", "length": 255, - "name": "key", + "name": "customer", "required": false, "type": "string" }, @@ -72420,32 +73020,25 @@ "type": "boolean" }, { - "description": "list by customer name", + "description": "list by resource type", "length": 255, - "name": "customer", + "name": "resourcetype", "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "list by key", "length": 255, - "name": "pagesize", + "name": "key", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list by resource type", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "resourcetype", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "List by keyword", @@ -72455,10 +73048,10 @@ "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, @@ -72469,6 +73062,13 @@ "required": false, "type": "string" }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "list by resource id", "length": 255, @@ -72477,58 +73077,56 @@ "type": "string" }, { - "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" } ], "related": "", "response": [ + {}, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain associated with the 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": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -72537,28 +73135,68 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, + {}, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], "since": "4.0.0" }, + { + "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": "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": "Get Kubernetes cluster config", "isasync": false, @@ -72582,21 +73220,21 @@ "type": "string" }, { - "description": "the config data of the cluster", - "name": "configdata", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the config data of the cluster", + "name": "configdata", + "type": "string" }, - {}, { "description": "Name of the container cluster", "name": "name", @@ -72628,9 +73266,11 @@ ], "related": "configureVirtualRouterElement,listVirtualRouterElements", "response": [ + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { @@ -72639,46 +73279,44 @@ "type": "integer" }, { - "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": "the domain ID associated with the provider", - "name": "domainid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, - {}, { "description": "the project id of the ipaddress", "name": "projectid", "type": "string" }, - { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" - }, { "description": "the id of the router", "name": "id", "type": "string" + }, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" } ] }, @@ -72688,81 +73326,87 @@ "name": "createVPC", "params": [ { - "description": "the ID of the availability zone", + "description": "create VPC for the project", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, "type": "uuid" }, { - "description": "the first IPv4 DNS for the VPC", + "description": "The display text of the VPC, defaults to its 'name'.", "length": 255, - "name": "dns1", + "name": "displaytext", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "VPC network domain. All networks inside the VPC will belong to this domain", + "description": "the second IPv4 DNS for the VPC", "length": 255, - "name": "networkdomain", + "name": "dns2", "required": false, + "since": "4.18.0", "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,", + "description": "the first IPv4 DNS for the VPC", "length": 255, - "name": "sourcenatipaddress", + "name": "dns1", "required": false, - "since": "4.19", + "since": "4.18.0", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", + "description": "the second IPv6 DNS for the VPC", "length": 255, - "name": "ip6dns1", + "name": "ip6dns2", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "an optional field, whether to the display the vpc to the end user or not", + "description": "VPC network domain. All networks inside the VPC will belong to this domain", "length": 255, - "name": "fordisplay", + "name": "networkdomain", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "The display text of the VPC, defaults to its 'name'.", + "description": "the account associated with the VPC. Must be used with the domainId parameter.", "length": 255, - "name": "displaytext", + "name": "account", "required": false, "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", + "description": "the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.", "length": 255, - "name": "ip6dns2", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { - "description": "the account associated with the VPC. Must be used with the domainId parameter.", + "description": "the ID of the availability zone", "length": 255, - "name": "account", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "length": 255, + "name": "cidr", + "required": true, "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "the name of the VPC", "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", - "type": "integer" + "name": "name", + "required": true, + "type": "string" }, { "description": "the ID of the VPC offering", @@ -72773,50 +73417,44 @@ "type": "uuid" }, { - "description": "create VPC for the project", + "description": "the first IPv6 DNS for the VPC", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "ip6dns1", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.", + "description": "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": "domainid", - "related": "listDomainChildren,listDomains", + "name": "sourcenatipaddress", "required": false, - "type": "uuid" + "since": "4.19", + "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.", + "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "start", + "name": "fordisplay", "required": false, - "since": "4.3", + "since": "4.4", "type": "boolean" }, { - "description": "the second IPv4 DNS for the VPC", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "dns2", + "name": "publicmtu", "required": false, "since": "4.18.0", - "type": "string" - }, - { - "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", - "length": 255, - "name": "cidr", - "required": true, - "type": "string" + "type": "integer" }, { - "description": "the name of the VPC", + "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": "name", - "required": true, - "type": "string" + "name": "start", + "required": false, + "since": "4.3", + "type": "boolean" } ], "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", @@ -72827,23 +73465,102 @@ "type": "date" }, { - "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the 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": "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 domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + { + "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 first IPv4 DNS for the VPC", - "name": "dns1", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, + {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { @@ -72852,14 +73569,71 @@ "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the owner of the VPC", + "name": "account", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, + { + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" + }, + { + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "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 name", "name": "name", @@ -72874,24 +73648,14 @@ "name": "destinationphysicalnetworkid", "type": "string" }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, { "description": "services for this provider", "name": "servicelist", "type": "list" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", "type": "string" }, { @@ -72903,28 +73667,16 @@ "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", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "uuid of the network provider", + "name": "id", + "type": "string" } ], "type": "list" @@ -72933,70 +73685,54 @@ "type": "list" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the id of the VPC", - "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.", - "name": "displaytext", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", - "type": "string" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "the id of the VPC", + "name": "id", + "type": "string" }, { "description": "the project name of the VPC", @@ -73004,117 +73740,19 @@ "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" - }, - {}, - { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the list of resource tags associated with the project", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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": "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 domain id of the VPC owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the name of the VPC", - "name": "name", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "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" } ] }, @@ -73133,11 +73771,6 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -73148,12 +73781,17 @@ "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" }, - {}, {} ] }, @@ -73172,27 +73810,27 @@ } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.9.0" @@ -73214,26 +73852,26 @@ "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -73242,26 +73880,34 @@ "name": "listInternalLoadBalancerVMs", "params": [ { - "description": "if true is passed for this parameter, list only VPC Internal LB VMs", + "description": "the Zone ID of the Internal LB VM", "length": 255, - "name": "forvpc", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List Internal LB VMs by VPC", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" + }, + { + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -73271,11 +73917,20 @@ "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List Internal LB VMs by VPC", "length": 255, - "name": "isrecursive", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "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": "list only resources belonging to the domain specified", @@ -73286,11 +73941,12 @@ "type": "uuid" }, { - "description": "the name of the Internal LB VM", + "description": "list by network id", "length": 255, - "name": "name", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the state of the Internal LB VM", @@ -73300,12 +73956,11 @@ "type": "string" }, { - "description": "the ID of the Internal LB VM", + "description": "if true is passed for this parameter, list only VPC Internal LB VMs", "length": 255, - "name": "id", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "forvpc", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "the Pod ID of the Internal LB VM", @@ -73316,34 +73971,32 @@ "type": "uuid" }, { - "description": "list by network id", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the name of the Internal LB VM", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", + "description": "List by keyword", "length": 255, - "name": "fetchhealthcheckresults", + "name": "keyword", "required": false, - "since": "4.14", - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -73354,51 +74007,155 @@ "type": "uuid" }, { - "description": "the host ID of the Internal LB VM", + "description": "the ID of the Internal LB VM", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "id", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, "type": "uuid" + } + ], + "related": "destroyRouter,listRouters", + "response": [ + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the Zone ID of the Internal LB VM", - "length": 255, + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the Zone ID for the router", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "destroyRouter,listRouters", - "response": [ + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + {}, + {}, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, { "description": "the version of scripts", "name": "scriptsversion", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the public IP address for the router", "name": "publicip", @@ -73410,8 +74167,43 @@ "type": "boolean" }, { - "description": "the Pod name for the router", - "name": "podname", + "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", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -73420,149 +74212,192 @@ "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the version of template", - "name": "version", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ + }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Type of adapter if available", + "name": "adaptertype", "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 type of the nic", - "name": "type", - "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 name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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 associated with this nic via Static nat rule", - "name": "publicip", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -73571,13 +74406,8 @@ "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": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -73586,59 +74416,54 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" }, { "description": "the isolation uri of the nic", "name": "isolationuri", "type": "string" }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { "description": "the IPv6 address of network", "name": "ip6address", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the nic", + "name": "id", "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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 type of the nic", + "name": "type", "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": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { "description": "Id of the vm to which the nic belongs", @@ -73646,484 +74471,292 @@ "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": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], "type": "set" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, + } + ] + }, + { + "description": "Lists Cisco VNMC controllers", + "isasync": false, + "name": "listCiscoVnmcResources", + "params": [ { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the account associated with the router", - "name": "account", - "type": "string" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "Cisco VNMC resource ID", + "length": 255, + "name": "resourceid", + "related": "listCiscoVnmcResources", + "required": false, + "type": "uuid" }, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, + {}, { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {} + ] + }, + { + "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": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" + "description": "Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=&migrateto[vm-index].host= Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm= indicates the UUID of the vm that you want to migrate, and host= indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", + "length": 255, + "name": "migrateto", + "required": false, + "type": "map" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, + "description": "ID of cluster", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, + {}, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" + "description": "List of migrations", + "name": "migrations", + "type": "list" }, + {}, { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, { - "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "Status of DRS Plan", + "name": "status", + "type": "status" }, + {}, { - "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" + } + ], + "since": "4.19.0" + }, + { + "description": "Removes detail for the Resource.", + "isasync": true, + "name": "removeResourceDetail", + "params": [ { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "Delete details for resource id", + "length": 255, + "name": "resourceid", + "required": true, "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "Delete detail by resource type", + "length": 255, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "Delete details matching key/value pairs", + "length": 255, + "name": "key", + "required": false, "type": "string" - }, + } + ], + "response": [ {}, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the project name of the address", - "name": "project", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - {} + } ] }, { - "description": "Lists Cisco VNMC controllers", + "description": "Lists all supported OS types for this cloud.", "isasync": false, - "name": "listCiscoVnmcResources", + "name": "listOsTypes", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "Cisco VNMC resource ID", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", + "name": "fordisplay", + "required": false, + "since": "4.18.1", + "type": "boolean" + }, + { + "description": "list by Os type Id", + "length": 255, + "name": "id", + "related": "listOsTypes,addGuestOs", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "list os by description", "length": 255, - "name": "keyword", + "name": "description", "required": false, + "since": "3.0.1", "type": "string" }, { - "description": "the Physical Network ID", + "description": "list by Os Category id", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "oscategoryid", + "related": "listOsCategories", "required": false, "type": "uuid" } ], - "related": "", + "related": "addGuestOs", "response": [ - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the OS category", + "name": "oscategoryname", + "type": "string" }, - {}, - {}, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the OS type", + "name": "name", "type": "string" }, - {} - ] - }, - { - "description": "Removes detail for the Resource.", - "isasync": true, - "name": "removeResourceDetail", - "params": [ { - "description": "Delete details for resource id", - "length": 255, - "name": "resourceid", - "required": true, + "description": "the ID of the OS type", + "name": "id", "type": "string" }, - { - "description": "Delete details matching key/value pairs", - "length": 255, - "name": "key", - "required": false, - "type": "string" - }, - { - "description": "Delete detail by resource type", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "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": "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", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - }, - { - "description": "Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=&migrateto[vm-index].host= Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm= indicates the UUID of the vm that you want to migrate, and host= indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", - "length": 255, - "name": "migrateto", - "required": false, - "type": "map" - } - ], - "related": "", - "response": [ - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" - }, - { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" - }, - { - "description": "unique ID of the drs plan for cluster", - "name": "id", - "type": "string" - }, - {}, - { - "description": "Start event Id of the DRS Plan", - "name": "eventid", - "type": "string" - }, - { - "description": "List of migrations", - "name": "migrations", - "type": "list" - }, - { - "description": "Id of the cluster", - "name": "clusterid", - "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Lists all supported OS types for this cloud.", - "isasync": false, - "name": "listOsTypes", - "params": [ - { - "description": "list by Os type Id", - "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" - }, - { - "description": "list os by description", - "length": 255, - "name": "description", - "required": false, - "since": "3.0.1", - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list by Os Category id", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "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.18.1", - "type": "boolean" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "addGuestOs", - "response": [ - { - "description": "is the guest OS visible for the users", - "name": "fordisplay", - "type": "boolean" - }, { "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 type", - "name": "name", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the name of the OS category", - "name": "oscategoryname", - "type": "string" - }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the ID of the OS category", "name": "oscategoryid", @@ -74134,6 +74767,11 @@ "description": "is the guest OS user defined", "name": "isuserdefined", "type": "boolean" + }, + { + "description": "is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" } ] }, @@ -74153,26 +74791,26 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "3.0.0" @@ -74193,26 +74831,26 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - { - "description": "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.4.0" @@ -74222,13 +74860,6 @@ "isasync": false, "name": "uploadResourceIcon", "params": [ - { - "description": "list of resources to upload the icon/image for", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" - }, { "description": "Base64 string representation of the resource icon/image", "length": 2097152, @@ -74242,13 +74873,20 @@ "name": "resourcetype", "required": true, "type": "string" + }, + { + "description": "list of resources to upload the icon/image for", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" } ], "response": [ { - "description": "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", @@ -74256,17 +74894,17 @@ "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - {} + } ], "since": "4.16.0.0" }, @@ -74275,13 +74913,6 @@ "isasync": false, "name": "updateKubernetesSupportedVersion", "params": [ - { - "description": "the enabled or disabled state of the Kubernetes supported version", - "length": 255, - "name": "state", - "required": true, - "type": "string" - }, { "description": "the ID of the Kubernetes supported version", "length": 255, @@ -74289,70 +74920,62 @@ "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "required": true, "type": "uuid" + }, + { + "description": "the enabled or disabled state of the Kubernetes supported version", + "length": 255, + "name": "state", + "required": true, + "type": "string" } ], "related": "listKubernetesSupportedVersions", "response": [ - { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, - { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" - }, { "description": "the minimum number of CPUs needed for the Kubernetes supported version", "name": "mincpunumber", "type": "integer" }, + {}, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", - "type": "string" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", - "type": "string" + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { "description": "the state of the binaries ISO for Kubernetes supported version", "name": "isostate", "type": "string" }, + { + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" + }, + {}, { "description": "the name of the binaries ISO for Kubernetes supported version", "name": "isoname", "type": "string" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { @@ -74361,24 +74984,39 @@ "type": "boolean" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, + { + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the id of the binaries ISO for Kubernetes supported version", "name": "isoid", "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "description": "Kubernetes semantic version", + "name": "semanticversion", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -74407,13 +75045,13 @@ "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the name of 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" }, { @@ -74422,240 +75060,438 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", + "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": "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": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + {}, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. 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": "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ip address of the nic", + "name": "ipaddress", "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": "id of the resource", - "name": "resourceid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "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": "customer associated with the tag", - "name": "customer", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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 ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" } ], "type": "set" }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, { "description": "Vm details in key/value pairs.", "name": "details", "type": "map" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, - {}, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the domain name of the security group", - "name": "domain", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "security group name", - "name": "securitygroupname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "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 list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { "description": "the domain ID of the security group", @@ -74663,61 +75499,86 @@ "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", + "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -74725,39 +75586,123 @@ "name": "account", "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 ID of the domain associated with the tag", "name": "domainid", "type": "string" }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { "description": "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": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the starting IP of the security group rule", "name": "startport", @@ -74769,116 +75714,54 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the security group", + "name": "id", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { @@ -74887,499 +75770,279 @@ "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 virtual machine", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the 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": "ssh key-pairs", + "name": "keypairs", "type": "string" }, + {}, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, - {}, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain ID of the affinity group", + "name": "domainid", "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 name of the affinity group", - "name": "name", + "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 ID of the affinity group", "name": "id", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "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", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" } ], "type": "set" }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, { "description": "the ID of the ISO attached to the virtual machine", "name": "isoid", "type": "string" }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, { "description": "the VM's disk read in KiB", "name": "diskkbsread", "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, + {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { @@ -75388,54 +76051,29 @@ "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" } ] }, @@ -75463,19 +76101,14 @@ "related": "listGuestNetworkIpv6Prefixes", "response": [ { - "description": "id of the guest IPv6 prefix", - "name": "id", + "description": "guest IPv6 prefix", + "name": "prefix", "type": "string" }, { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" - }, - { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", - "type": "integer" + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" }, { "description": "the UUID of the latest async job acting on this object", @@ -75483,19 +76116,13 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", "type": "integer" }, { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" - }, - {}, - { - "description": "guest IPv6 prefix", - "name": "prefix", + "description": "id of the guest IPv6 prefix", + "name": "id", "type": "string" }, { @@ -75503,12 +76130,23 @@ "name": "zoneid", "type": "string" }, + {}, { "description": "count of the used IPv6 subnets for the prefix.", "name": "usedsubnets", "type": "integer" }, - {} + { + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.17.0.0" }, @@ -75528,26 +76166,26 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - {}, + { + "description": "the 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" } ] }, @@ -75566,26 +76204,26 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -75596,11 +76234,12 @@ "name": "listTungstenFabricProviders", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -75612,60 +76251,55 @@ { "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ - { - "description": "Tungsten-Fabric provider hostname", - "name": "tungstenproviderhostname", - "type": "string" - }, {}, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider name", + "name": "name", "type": "string" }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider vrouter port", - "name": "tungstenprovidervrouterport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", "type": "string" }, { @@ -75674,19 +76308,23 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider name", - "name": "name", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" }, - {}, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", + "type": "string" }, { - "description": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", "type": "string" } ] @@ -75720,113 +76358,24 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "Deployment Planner name", - "name": "name", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} - ] - }, - { - "description": "Creates a role", - "isasync": false, - "name": "createRole", - "params": [ - { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, - { - "description": "The description of the role", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { - "description": "Creates a role with this unique name", - "length": 255, + "description": "Deployment Planner name", "name": "name", - "required": true, "type": "string" }, - { - "description": "ID of the role to be cloned from. Either roleid or type must be passed in", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" - }, - { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - } - ], - "related": "importRole,listRoles,updateRole", - "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 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" - }, - { - "description": "the description of the role", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {} - ], - "since": "4.9.0" + ] }, { "description": "Deletes a cluster.", @@ -75843,26 +76392,26 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -75876,37 +76425,68 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": true, "type": "uuid" } ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "response": [ { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, + {}, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" }, { "description": "the cluster type of the cluster that host belongs to", @@ -75914,20 +76494,65 @@ "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" + }, { "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", "name": "cpuallocatedwithoverprovisioning", @@ -75939,45 +76564,44 @@ "type": "outofbandmanagementresponse" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { "description": "true if the host has capability to support UEFI boot", @@ -75985,41 +76609,36 @@ "type": "boolean" }, { - "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": "GPU cards present in the host", "name": "gpugroup", "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, { "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "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", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { @@ -76028,80 +76647,86 @@ "type": "string" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, + {}, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "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 amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "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 total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "the management server ID of the host", @@ -76109,9 +76734,9 @@ "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { "description": "the OS category ID of the host", @@ -76119,142 +76744,155 @@ "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "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", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, { "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 amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, + "description": "the host type", + "name": "type", + "type": "type" + } + ] + }, + { + "description": "Creates a role", + "isasync": false, + "name": "createRole", + "params": [ { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "The description of the role", + "length": 255, + "name": "description", + "required": false, + "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "Creates a role with this unique name", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "ID of the role to be cloned from. Either roleid or type must be passed in", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": false, + "type": "uuid" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" }, - {}, { - "description": "the Pod name of the host", - "name": "podname", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "length": 255, + "name": "type", + "required": false, "type": "string" - }, + } + ], + "related": "importRole,listRoles,updateRole", + "response": [ { - "description": "the host version", - "name": "version", + "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 role", + "name": "id", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if role is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the description of the role", + "name": "description", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "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 resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" - } - ] + {} + ], + "since": "4.9.0" }, { "description": "Removes specified region", @@ -76272,25 +76910,25 @@ "response": [ {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -76310,22 +76948,22 @@ "related": "", "response": [ {}, - { - "description": "Volume iSCSI Name", - "name": "volumeiScsiName", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + { + "description": "Volume iSCSI Name", + "name": "volumeiScsiName", + "type": "string" + }, + {} ] }, { @@ -76334,25 +76972,18 @@ "name": "getUploadParamsForVolume", "params": [ { - "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "checksum", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "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": "an optional accountName. Must be used with domainId.", + "description": "the name of the volume/template/iso", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -76363,19 +76994,11 @@ "type": "string" }, { - "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "Upload volume/template/iso for the project", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" }, { @@ -76394,19 +77017,40 @@ "type": "string" }, { - "description": "the name of the volume/template/iso", + "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", "length": 255, - "name": "name", - "required": true, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": false, + "type": "uuid" + }, + { + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", + "required": false, "type": "string" } ], "related": "getUploadParamsForTemplate,getUploadParamsForIso", "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": "POST url to upload the file to", + "name": "postURL", + "type": "url" }, { "description": "the template/volume ID", @@ -76414,30 +77058,24 @@ "type": "uuid" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" }, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "signature to be sent in the POST request.", + "name": "signature", "type": "string" }, - { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" - }, - {}, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" } ], @@ -76449,12 +77087,11 @@ "name": "updateAutoScaleVmGroup", "params": [ { - "description": "an optional field, whether to the display the group to the end user or not", + "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": "fordisplay", + "name": "minmembers", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { "description": "the frequency in which the performance counters to be collected", @@ -76463,13 +77100,6 @@ "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, @@ -76479,24 +77109,32 @@ "type": "string" }, { - "description": "list of scaleup autoscale policies", + "description": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "fordisplay", "required": false, - "type": "list" + "since": "4.4", + "type": "boolean" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "description": "the 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": "minmembers", + "name": "maxmembers", "required": false, "type": "integer" }, { - "description": "list of scaledown autoscale policies", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "scaledownpolicyids", + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "list of scaleup autoscale policies", + "length": 255, + "name": "scaleuppolicyids", "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, "type": "list" @@ -76510,12 +77148,12 @@ "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "list of scaledown autoscale policies", "length": 255, - "name": "customid", + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "since": "4.4", - "type": "string" + "type": "list" } ], "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", @@ -76526,40 +77164,40 @@ "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the public ip address id", + "name": "publicipid", + "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { "description": "is group for display to the regular user", "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { "description": "the project name of the vm group", @@ -76567,9 +77205,14 @@ "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" }, { "description": "the private port", @@ -76577,90 +77220,85 @@ "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", "type": "int" }, - {}, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "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": "the public port", + "name": "publicport", + "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", - "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", - "name": "jobstatus", - "type": "integer" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -76670,18 +77308,19 @@ "name": "updateAutoScaleVmProfile", "params": [ { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "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": "expungevmgraceperiod", + "name": "otherdeployparams", "required": false, - "type": "integer" + "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", + "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.18.0", + "since": "4.4", "type": "string" }, { @@ -76693,19 +77332,11 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the profile to the end user or not", + "description": "the template of the auto deployed virtual machine", "length": 255, - "name": "fordisplay", + "name": "templateid", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the ID of the autoscale vm profile", - "length": 255, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, "type": "uuid" }, { @@ -76717,37 +77348,28 @@ "type": "map" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "description": "the service offering of the auto deployed virtual machine", "length": 255, - "name": "otherdeployparams", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, "since": "4.18.0", - "type": "map" - }, - { - "description": "the ID of the userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "since": "4.18.1", "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", "length": 255, - "name": "customid", + "name": "expungevmgraceperiod", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" }, { - "description": "the template of the auto deployed virtual machine", + "description": "an optional field, whether to the display the profile to the end user or not", "length": 255, - "name": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", @@ -76757,94 +77379,115 @@ "type": "map" }, { - "description": "the service offering of the auto deployed virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", "required": false, "since": "4.18.0", + "type": "string" + }, + { + "description": "the ID of the userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18.1", + "type": "uuid" + }, + { + "description": "the ID of the autoscale vm profile", + "length": 255, + "name": "id", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, "type": "uuid" } ], "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", "response": [ { - "description": "the project name of the vm profile", - "name": "project", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, + {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, {}, { - "description": "Base 64 encoded VM user data", - "name": "userdata", - "type": "string" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, {}, { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account owning the instance group", + "name": "account", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" + }, + { + "description": "Base 64 encoded VM user data", + "name": "userdata", "type": "string" }, {}, { - "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 availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -76853,24 +77496,19 @@ "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" - }, - { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "description": "the domain name of the vm profile", + "name": "domain", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -76891,40 +77529,40 @@ "related": "listAutoScaleVmGroups", "response": [ { - "description": "the project id of the vm group", - "name": "projectid", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "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 public port", + "name": "publicport", + "type": "string" }, - {}, { - "description": "the private port", - "name": "privateport", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "the project id of the vm group", + "name": "projectid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", + "type": "string" }, { "description": "the frequency at which the conditions have to be evaluated", @@ -76932,18 +77570,23 @@ "type": "int" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the date when this vm group was created", + "name": "created", + "type": "date" + }, + { + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { @@ -76952,19 +77595,14 @@ "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "description": "the project name of the vm group", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { "description": "list of scaledown autoscale policies", @@ -76972,44 +77610,48 @@ "type": "list" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the public ip address id", + "name": "publicipid", + "type": "string" }, - {}, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "the name of the autoscale vm group ", + "name": "name", + "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + }, + { + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { @@ -77018,20 +77660,16 @@ "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", - "type": "string" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the public port", - "name": "publicport", - "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" - } + {} ] }, { @@ -77039,6 +77677,14 @@ "isasync": true, "name": "deleteSnapshot", "params": [ + { + "description": "The ID of the snapshot", + "length": 255, + "name": "id", + "related": "copySnapshot,revertSnapshot,listSnapshots", + "required": true, + "type": "uuid" + }, { "description": "The ID of the zone for the snapshot", "length": 255, @@ -77047,27 +77693,20 @@ "required": false, "since": "4.19.0", "type": "uuid" - }, - { - "description": "The ID of the snapshot", - "length": 255, - "name": "id", - "related": "copySnapshot,revertSnapshot,listSnapshots", - "required": true, - "type": "uuid" } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -77075,113 +77714,103 @@ "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 guest network IPv6 prefixes", + "description": "List the virtual machines owned by the account.", "isasync": false, - "name": "listGuestNetworkIpv6Prefixes", + "name": "listVirtualMachines", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "UUID of zone to which the IPv6 prefix belongs to.", + "description": "list by network id", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "", + "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": "pagesize", + "name": "accumulate", "required": false, - "type": "integer" + "since": "4.17.0", + "type": "boolean" }, { - "description": "UUID of the IPv6 prefix.", + "description": "list vms by ssh keypair name", "length": 255, - "name": "id", - "related": "listGuestNetworkIpv6Prefixes", + "name": "keypair", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "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": "keyword", + "name": "name", "required": false, "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", - "type": "integer" }, { - "description": "guest IPv6 prefix", - "name": "prefix", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, - {}, { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", - "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": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" + "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": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "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": "id of the guest IPv6 prefix", - "name": "id", - "type": "string" + "description": "list by the backup offering", + "length": 255, + "name": "backupofferingid", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": " date when this IPv6 prefix 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" }, - {} - ], - "since": "4.17.0" - }, - { - "description": "List the virtual machines owned by the account.", - "isasync": false, - "name": "listVirtualMachines", - "params": [ { "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", "length": 255, @@ -77191,87 +77820,98 @@ "type": "boolean" }, { - "description": "the target hypervisor for the template", + "description": "the security group ID", "length": 255, - "name": "hypervisor", + "name": "securitygroupid", + "related": "createSecurityGroup", "required": false, - "type": "string" + "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.", + "description": "list by the service offering", "length": 255, - "name": "listall", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "boolean" + "since": "4.4", + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the ID of the virtual machine", "length": 255, - "name": "displayvm", + "name": "id", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "list by the service offering", + "description": "list vms by template", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "templateid", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "list vms by ssh keypair name", + "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": "keypair", + "name": "state", "required": false, "type": "string" }, { - "description": "flag to display the resource icon for VMs", + "description": "", "length": 255, - "name": "showicon", + "name": "pagesize", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "type": "integer" }, { - "description": "", + "description": "the cluster ID", "length": 255, - "name": "page", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "integer" + "since": "4.16.0", + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the pod ID", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "", + "description": "the availability zone ID", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the target hypervisor for the template", "length": 255, - "name": "isrecursive", + "name": "hypervisor", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list vms by iso", @@ -77281,45 +77921,50 @@ "type": "uuid" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "ids", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.4", - "type": "list" + "type": "boolean" }, { - "description": "the availability zone ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", "length": 255, - "name": "accumulate", + "name": "details", "required": false, - "since": "4.17.0", - "type": "boolean" + "type": "list" }, { - "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 IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "name", + "name": "ids", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "since": "4.4", + "type": "list" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "haenable", + "name": "showicon", "required": false, - "since": "4.15", + "since": "4.16.0.0", "type": "boolean" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "List by keyword", "length": 255, @@ -77328,25 +77973,25 @@ "type": "string" }, { - "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "details", + "name": "tags", "required": false, - "type": "list" + "type": "map" }, { - "description": "list by the backup offering", + "description": "list vms by affinity group", "length": 255, - "name": "backupofferingid", + "name": "affinitygroupid", + "related": "", "required": false, - "since": "4.17", "type": "uuid" }, { - "description": "list vms by affinity group", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" }, @@ -77368,153 +78013,245 @@ "type": "uuid" }, { - "description": "list by network id", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "forvirtualnetwork", + "name": "displayvm", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the host ID", + "description": "list vms by vpc", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" + } + ], + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "response": [ + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the name of the virtual machine", + "name": "name", + "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 password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "since": "4.16.0", - "type": "uuid" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "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": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the pod ID", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "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": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the ID of the virtual machine", - "length": 255, - "name": "id", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "list vms by vpc", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "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 project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "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 virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, + "description": "the account associated with the virtual machine", "name": "account", - "required": false, "type": "string" }, { - "description": "the security group ID", - "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup", - "required": false, - "since": "4.15", - "type": "uuid" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" - } - ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, { "description": "the number of vCPUs this virtual machine is using", "name": "cpunumber", "type": "integer" }, - {}, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { "description": "device type of the root volume", @@ -77522,33 +78259,83 @@ "type": "string" }, { - "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 project name of the vm", - "name": "project", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { @@ -77556,72 +78343,67 @@ "name": "securitygroup", "response": [ { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the 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 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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -77630,55 +78412,40 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the 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", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -77691,48 +78458,48 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], @@ -77744,57 +78511,57 @@ "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 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 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": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -77805,63 +78572,93 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the 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 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", @@ -77869,132 +78666,115 @@ } ], "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" } ], "type": "set" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "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 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 ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, + {}, + {}, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the 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", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { @@ -78018,46 +78798,55 @@ "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { "description": "virtual machine IDs associated with this affinity group", "name": "virtualmachineIds", "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, - {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -78066,18 +78855,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -78090,217 +78874,121 @@ "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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, - { - "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the 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": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -78309,224 +78997,174 @@ "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the name of the corresponding network", + "name": "networkname", "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": "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" } ], "type": "set" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + } + ] + }, + { + "description": "Lists guest network IPv6 prefixes", + "isasync": false, + "name": "listGuestNetworkIpv6Prefixes", + "params": [ { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "UUID of zone to which the IPv6 prefix belongs to.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, + "description": "UUID of the IPv6 prefix.", + "length": 255, + "name": "id", + "related": "listGuestNetworkIpv6Prefixes", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, { - "description": "the ID of the availability zone for the virtual machine", + "description": "id of zone to which the IPv6 prefix belongs to.", "name": "zoneid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", + "type": "integer" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "guest IPv6 prefix", + "name": "prefix", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", "type": "integer" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" }, + {}, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "id of the guest IPv6 prefix", + "name": "id", "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" } - ] + ], + "since": "4.17.0" }, { "description": "Updates the information about Guest OS to Hypervisor specific name mapping", @@ -78560,24 +79198,25 @@ "related": "", "response": [ { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" }, {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the Guest OS type", + "name": "ostypeid", + "type": "string" }, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "the ID of the Guest OS mapping", + "name": "id", "type": "string" }, { @@ -78586,8 +79225,8 @@ "type": "string" }, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { @@ -78596,16 +79235,15 @@ "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", - "type": "string" + "description": "the current status of the latest async job 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.4.0" }, @@ -78614,13 +79252,6 @@ "isasync": true, "name": "deleteTungstenFabricTag", "params": [ - { - "description": "the uuid of Tungsten-Fabric tag", - "length": 255, - "name": "taguuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -78628,16 +79259,27 @@ "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -78648,11 +79290,7 @@ "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -78660,30 +79298,6 @@ "isasync": false, "name": "listDiskOfferings", "params": [ - { - "description": "id of zone disk offering is associated with", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "uuid" - }, - { - "description": "name of the disk offering", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "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, tags of the storage pool are used to filter the offerings", "length": 255, @@ -78702,27 +79316,26 @@ "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "isrecursive", + "name": "storagetype", "required": false, - "type": "boolean" + "since": "4.19", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The ID of the volume, tags of the volume are used to filter the offerings", + "description": "List by keyword", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "keyword", "required": false, - "since": "4.17", - "type": "uuid" + "type": "string" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -78741,18 +79354,18 @@ "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -78762,67 +79375,73 @@ "type": "boolean" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "name of the disk offering", "length": 255, - "name": "storagetype", + "name": "name", "required": false, - "since": "4.19", "type": "string" }, { - "description": "List by keyword", + "description": "id of zone disk offering is associated with", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" - } - ], - "related": "createDiskOffering", - "response": [ - { - "description": "unique ID of the disk offering", - "name": "id", - "type": "string" - }, - { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "since": "4.13", + "type": "uuid" }, { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" + "description": "The ID of the volume, tags of the volume are used to filter the offerings", + "length": 255, + "name": "volumeid", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "createDiskOffering", + "response": [ { "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "name": "provisioningtype", "type": "string" }, - { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" - }, { "description": "whether to display the offering to the end user or not.", "name": "displayoffering", "type": "boolean" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, + {}, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" + }, + { + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" }, { "description": "the size of the disk offering in GB", @@ -78830,54 +79449,53 @@ "type": "long" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, - {}, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "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 domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the name of the disk offering", + "name": "name", + "type": "string" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { @@ -78886,38 +79504,49 @@ "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "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": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, { @@ -78926,49 +79555,58 @@ "type": "map" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "the storage type for this disk offering", + "name": "storagetype", + "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "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 date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" } ] @@ -78979,11 +79617,11 @@ "name": "updateHostPassword", "params": [ { - "description": "the new password for the host/cluster", + "description": "if the password should also be updated on the hosts", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "update_passwd_on_host", + "required": false, + "type": "boolean" }, { "description": "the cluster ID", @@ -78994,16 +79632,16 @@ "type": "uuid" }, { - "description": "if the password should also be updated on the hosts", + "description": "the username for the host/cluster", "length": 255, - "name": "update_passwd_on_host", - "required": false, - "type": "boolean" + "name": "username", + "required": true, + "type": "string" }, { - "description": "the username for the host/cluster", + "description": "the new password for the host/cluster", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, @@ -79011,16 +79649,16 @@ "description": "the host ID", "length": 255, "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" } ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "true if operation is executed successfully", @@ -79028,9 +79666,9 @@ "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" }, {}, { @@ -79047,74 +79685,101 @@ "name": "createPortableIpRange", "params": [ { - "description": "the beginning IP address in the portable IP range", + "description": "VLAN id, if not specified defaulted to untagged", "length": 255, - "name": "startip", - "required": true, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "the netmask of the portable IP range", + "description": "the ending IP address in the portable IP range", "length": 255, - "name": "netmask", + "name": "endip", "required": true, "type": "string" }, { - "description": "Id of the Region", + "description": "the gateway for the portable IP range", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "gateway", "required": true, - "type": "integer" + "type": "string" }, { - "description": "VLAN id, if not specified defaulted to untagged", + "description": "the beginning IP address in the portable IP range", "length": 255, - "name": "vlan", - "required": false, + "name": "startip", + "required": true, "type": "string" }, { - "description": "the ending IP address in the portable IP range", + "description": "Id of the Region", "length": 255, - "name": "endip", + "name": "regionid", + "related": "addRegion,listRegions", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the gateway for the portable IP range", + "description": "the netmask of the portable IP range", "length": 255, - "name": "gateway", + "name": "netmask", "required": true, "type": "string" } ], "related": "", "response": [ + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" + }, + {}, + {}, + { + "description": "portable IP range ID", + "name": "id", + "type": "string" + }, + { + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" + }, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, { "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", "name": "portableipaddress", "response": [ { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the account ID the portable IP address is associated with", + "name": "accountid", + "type": "string" }, { "description": "the ID of the Network where ip belongs to", @@ -79122,23 +79787,23 @@ "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", - "name": "state", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", - "type": "string" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { @@ -79149,458 +79814,310 @@ ], "type": "list" }, - { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the end ip of the portable IP range", - "name": "endip", - "type": "string" - }, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "string" - }, - { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" - }, { "description": "the start ip of the portable IP range", "name": "startip", "type": "string" }, - {}, { - "description": "portable IP range ID", - "name": "id", + "description": "the end ip of the portable IP range", + "name": "endip", "type": "string" }, - { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", - "type": "integer" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ], "since": "4.2.0" }, { - "description": "Updates an existing cluster", + "description": "Lists the VMs in a VMware Datacenter", "isasync": false, - "name": "updateCluster", + "name": "listVmwareDcVms", "params": [ { - "description": "the ID of the Cluster", + "description": "UUID of a linked existing vCenter", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, + "name": "existingvcenterid", + "related": "addVmwareDc,listVmwareDcs", + "required": false, "type": "uuid" }, { - "description": "hypervisor type of the cluster", + "description": "", "length": 255, - "name": "hypervisor", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "hypervisor type of the cluster", + "description": "The Username required to connect to resource.", "length": 255, - "name": "clustertype", + "name": "username", "required": false, "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "List by keyword", "length": 255, - "name": "allocationstate", + "name": "keyword", "required": false, "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "The password for specified username.", "length": 255, - "name": "managedstate", + "name": "password", "required": false, "type": "string" }, { - "description": "the cluster name", + "description": "", "length": 255, - "name": "clustername", + "name": "page", "required": false, - "type": "string" - } - ], - "related": "addCluster", - "response": [ - {}, - { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" - }, - { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "type": "integer" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "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": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "Name of VMware datacenter.", + "length": 255, + "name": "datacentername", + "required": false, "type": "string" - }, + } + ], + "related": "listUnmanagedInstances", + "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", "type": "integer" }, { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, - {}, { - "description": "the cluster name", + "description": "the name of the virtual machine", "name": "name", "type": "string" }, + {}, { - "description": "the cluster ID", - "name": "id", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the capacity of the Cluster", - "name": "capacity", + "description": "the list of disks associated with the virtual machine", + "name": "disk", "response": [ { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the file path of the disk image", + "name": "imagepath", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the controller of the disk", + "name": "datastorehost", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the controller of the disk", + "name": "controller", + "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the position of the disk", + "name": "position", + "type": "integer" }, { - "description": "the capacity name", - "name": "name", - "type": "string" + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the ID of the disk", + "name": "id", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the controller of the disk", + "name": "datastoretype", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the label of the disk", + "name": "label", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the controller of the disk", + "name": "datastorename", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" } ], - "type": "list" + "type": "set" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the operating system of the virtual machine", + "name": "osdisplayname", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Lists the VMs in a VMware Datacenter", - "isasync": false, - "name": "listVmwareDcVms", - "params": [ - { - "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", - "length": 255, - "name": "vcenter", - "required": false, - "type": "string" - }, - { - "description": "UUID of a linked existing vCenter", - "length": 255, - "name": "existingvcenterid", - "related": "addVmwareDc,listVmwareDcs", - "required": false, - "type": "uuid" - }, - { - "description": "The password for specified username.", - "length": 255, - "name": "password", - "required": false, - "type": "string" + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" }, + {}, { - "description": "Name of VMware datacenter.", - "length": 255, - "name": "datacentername", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The Username required to connect to resource.", - "length": 255, - "name": "username", - "required": false, + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "listUnmanagedInstances", - "response": [ { "description": "the CPU cores of the virtual machine", "name": "cpunumber", "type": "integer" }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, { "description": "the name of the host to which virtual machine belongs", "name": "hostname", "type": "string" }, - {}, - { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", - "type": "string" - }, { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" - }, - { - "description": "the list of disks associated with the virtual machine", - "name": "disk", + "description": "the list of nics associated with the virtual machine", + "name": "nic", "response": [ { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the label of the disk", - "name": "label", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the controller of the disk", - "name": "datastorepath", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastorename", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the ID of the disk", - "name": "id", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of nics associated with the virtual machine", - "name": "nic", - "response": [ + }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the type of the nic", + "name": "type", "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 vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -79608,30 +80125,40 @@ "name": "secondaryip", "type": "list" }, + { + "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 (if NSX based), null otherwise", "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { "description": "the ID of the nic", @@ -79639,92 +80166,182 @@ "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the operating system ID of the virtual machine", + "name": "osid", + "type": "string" + } + ] + }, + { + "description": "Updates an existing cluster", + "isasync": false, + "name": "updateCluster", + "params": [ + { + "description": "hypervisor type of the cluster", + "length": 255, + "name": "clustertype", + "required": false, + "type": "string" + }, + { + "description": "the cluster name", + "length": 255, + "name": "clustername", + "required": false, + "type": "string" + }, + { + "description": "whether this cluster is managed by cloudstack", + "length": 255, + "name": "managedstate", + "required": false, + "type": "string" + }, + { + "description": "hypervisor type of the cluster", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" + }, + { + "description": "the ID of the Cluster", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "related": "addCluster", + "response": [ + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the cluster ID", + "name": "id", + "type": "string" + }, + { + "description": "the capacity of the Cluster", + "name": "capacity", + "response": [ { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" } ], - "type": "set" + "type": "list" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + { + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -79732,40 +80349,61 @@ "type": "string" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", + "type": "string" + }, + { + "description": "the Zone name of the cluster", + "name": "zonename", + "type": "string" } ] }, @@ -79784,28 +80422,28 @@ } ], "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + } ] }, { @@ -79833,81 +80471,91 @@ "related": "createKubernetesCluster,startKubernetesCluster", "response": [ { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "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": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, - {}, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, + { + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, { "description": "the list of virtualmachine associated with this Kubernetes cluster", "name": "virtualmachines", "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, + {}, { "description": "the name of the zone of the Kubernetes cluster", "name": "zonename", @@ -79918,35 +80566,45 @@ "name": "memory", "type": "string" }, + {}, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, - {}, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "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": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { @@ -79955,19 +80613,19 @@ "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", - "type": "string" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { "description": "the name of the zone of the Kubernetes cluster", @@ -79975,18 +80633,13 @@ "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" - }, - { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { @@ -79995,29 +80648,14 @@ "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" - }, - { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" - }, - { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" }, { "description": "URL end point for the Kubernetes cluster dashboard UI", "name": "consoleendpoint", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -80027,19 +80665,11 @@ "name": "listUcsProfiles", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" - }, - { - "description": "the id for the ucs manager", - "length": 255, - "name": "ucsmanagerid", - "related": "addUcsManager", - "required": true, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -80049,16 +80679,28 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "the id for the ucs manager", + "length": 255, + "name": "ucsmanagerid", + "related": "addUcsManager", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - {}, + { + "description": "ucs profile dn", + "name": "ucsdn", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -80070,11 +80712,7 @@ "name": "jobid", "type": "string" }, - { - "description": "ucs profile dn", - "name": "ucsdn", - "type": "string" - } + {} ] }, { @@ -80082,13 +80720,6 @@ "isasync": false, "name": "listStorageProviders", "params": [ - { - "description": "the type of storage provider: either primary or image", - "length": 255, - "name": "type", - "required": true, - "type": "string" - }, { "description": "", "length": 255, @@ -80103,6 +80734,13 @@ "required": false, "type": "integer" }, + { + "description": "the type of storage provider: either primary or image", + "length": 255, + "name": "type", + "required": true, + "type": "string" + }, { "description": "List by keyword", "length": 255, @@ -80118,6 +80756,7 @@ "name": "name", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -80125,14 +80764,13 @@ }, {}, { - "description": "the type of the storage provider: primary or image provider", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the storage provider: primary or image provider", + "name": "type", "type": "string" } ] @@ -80153,27 +80791,27 @@ ], "related": "registerUserKeys", "response": [ + {}, { - "description": "the secret key of the registered user", - "name": "secretkey", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the api key of the registered user", "name": "apikey", "type": "string" }, + { + "description": "the secret key of the registered user", + "name": "secretkey", + "type": "string" + }, { "description": "the current status of the latest async job 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.10.0" @@ -80183,6 +80821,13 @@ "isasync": true, "name": "updateGlobalLoadBalancerRule", "params": [ + { + "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "length": 255, + "name": "gslbstickysessionmethodname", + "required": false, + "type": "string" + }, { "description": "the description of the load balancer rule", "length": 4096, @@ -80204,25 +80849,18 @@ "related": "updateGlobalLoadBalancerRule", "required": true, "type": "uuid" - }, - { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", - "length": 255, - "name": "gslbstickysessionmethodname", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", + "type": "string" }, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { @@ -80231,44 +80869,33 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the description of the global load balancer rule", - "name": "description", - "type": "string" - }, - { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, { - "description": "global load balancer rule ID", - "name": "id", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { @@ -80276,24 +80903,18 @@ "name": "account", "type": "string" }, - {}, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, { "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ { - "description": "the project name of the load balancer", - "name": "project", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the private port", + "name": "privateport", "type": "string" }, { @@ -80302,18 +80923,23 @@ "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { @@ -80322,13 +80948,38 @@ "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { @@ -80337,18 +80988,18 @@ "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { @@ -80360,21 +81011,11 @@ "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", @@ -80386,13 +81027,8 @@ "type": "string" }, { - "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" }, { @@ -80406,54 +81042,56 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" } ], "type": "list" }, + {}, + {}, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "GSLB service type", + "name": "gslbservicetype", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" } ] @@ -80464,11 +81102,18 @@ "name": "createCondition", "params": [ { - "description": "Value for which the Counter will be evaluated with the Operator selected.", + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", "length": 255, - "name": "threshold", + "name": "relationaloperator", "required": true, - "type": "long" + "type": "string" + }, + { + "description": "the account of the condition. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { "description": "ID of the Counter.", @@ -80487,11 +81132,11 @@ "type": "uuid" }, { - "description": "the account of the condition. Must be used with the domainId parameter.", + "description": "Value for which the Counter will be evaluated with the Operator selected.", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "threshold", + "required": true, + "type": "long" }, { "description": "the domain ID of the account.", @@ -80500,25 +81145,18 @@ "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" - }, - { - "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", - "length": 255, - "name": "relationaloperator", - "required": true, - "type": "string" } ], "related": "", "response": [ { - "description": "the id of the Condition", - "name": "id", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, { - "description": "the Id of the Counter.", - "name": "counterid", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" }, { @@ -80527,9 +81165,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" }, { "description": "Relational Operator to be used with threshold.", @@ -80541,46 +81179,46 @@ "name": "zoneid", "type": "string" }, + { + "description": "the Name of the Counter.", + "name": "countername", + "type": "string" + }, + { + "description": "the project name of the Condition", + "name": "project", + "type": "string" + }, + { + "description": "the Id of the Counter.", + "name": "counterid", + "type": "string" + }, + {}, { "description": "Details of the Counter.", "name": "counter", "type": "counterresponse" }, + {}, { - "description": "the project id of the Condition.", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, { - "description": "the Name of the Counter.", - "name": "countername", - "type": "string" - }, - {}, - { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" - }, - { - "description": "the domain name of the owner.", - "name": "domain", - "type": "string" - }, - { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "the id of the Condition", + "name": "id", "type": "string" } ] @@ -80590,13 +81228,6 @@ "isasync": false, "name": "listProjects", "params": [ - { - "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", - "length": 255, - "name": "details", - "required": false, - "type": "list" - }, { "description": "", "length": 255, @@ -80605,26 +81236,33 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List projects by username", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "username", + "name": "account", "required": false, "type": "string" }, { - "description": "flag to display the resource icon for projects", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "showicon", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", + "length": 255, + "name": "details", + "required": false, + "type": "list" }, { "description": "", @@ -80634,32 +81272,33 @@ "type": "integer" }, { - "description": "list projects by state", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "state", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list projects by project ID", "length": 255, - "name": "account", + "name": "id", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "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 projects by username", "length": 255, - "name": "listall", + "name": "username", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list projects by name", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "List projects by tags (key/value pairs)", @@ -80669,80 +81308,49 @@ "type": "map" }, { - "description": "list projects by project ID", + "description": "list projects by display text", "length": 255, - "name": "id", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "list projects by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list projects by state", "length": 255, - "name": "isrecursive", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list projects by display text", + "description": "flag to display the resource icon for projects", "length": 255, - "name": "displaytext", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" } ], "related": "listProjectAccounts,activateProject,suspendProject,updateProject", "response": [ { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" - }, - { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "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 available to be created for this project", - "name": "cpuavailable", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { @@ -80751,68 +81359,28 @@ "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the state of the project", + "name": "state", "type": "string" }, { @@ -80820,60 +81388,45 @@ "name": "domain", "type": "string" }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, { "description": "the total number of cpu cores the project can own", "name": "cpulimit", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "the total volume being used by this project", + "name": "volumetotal", + "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 snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the list of resource tags associated with vm", @@ -80890,23 +81443,23 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "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" }, { @@ -80915,68 +81468,137 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" }, - {}, { - "description": "the state of the project", - "name": "state", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" + }, + {}, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" + }, { "description": "the name of the project", "name": "name", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, - {}, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { @@ -80985,14 +81607,30 @@ "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "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 project", + "name": "cpuavailable", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", "type": "integer" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" } ], "since": "3.0.0" @@ -81003,32 +81641,38 @@ "name": "createAccount", "params": [ { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "lastname", "length": 255, - "name": "timezone", - "required": false, + "name": "lastname", + "required": true, "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "userid", + "name": "accounttype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Creates the account under the specified role.", + "description": "details for account used to store specific parameters", "length": 255, - "name": "roleid", - "related": "importRole,listRoles,updateRole", + "name": "accountdetails", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "Creates the user under the specified domain.", + "description": "firstname", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "firstname", + "required": true, + "type": "string" + }, + { + "description": "Creates the account under the specified role.", + "length": 255, + "name": "roleid", + "related": "importRole,listRoles,updateRole", "required": false, "type": "uuid" }, @@ -81040,31 +81684,31 @@ "type": "string" }, { - "description": "lastname", + "description": "Network domain for the account's networks", "length": 255, - "name": "lastname", - "required": true, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "details for account used to store specific parameters", + "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": "accountdetails", - "required": false, - "type": "map" + "name": "password", + "required": true, + "type": "string" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "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": "accounttype", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "password", - "required": true, + "name": "userid", + "required": false, "type": "string" }, { @@ -81075,30 +81719,24 @@ "type": "string" }, { - "description": "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "account", + "name": "timezone", "required": false, "type": "string" }, { - "description": "email", - "length": 255, - "name": "email", - "required": true, - "type": "string" - }, - { - "description": "Network domain for the account's networks", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "networkdomain", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "firstname", + "description": "email", "length": 255, - "name": "firstname", + "name": "email", "required": true, "type": "string" } @@ -81106,78 +81744,8 @@ "related": "enableAccount,listAccounts,listAccounts", "response": [ { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the state of the account", - "name": "state", - "type": "string" - }, - { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { @@ -81186,48 +81754,8 @@ "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "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 type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the state of the account", + "name": "state", "type": "string" }, { @@ -81236,48 +81764,22 @@ "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "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 vpcs the account can own", + "name": "vpclimit", "type": "string" }, - { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the user email address", - "name": "email", + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the user state", + "name": "state", "type": "string" }, { @@ -81286,14 +81788,14 @@ "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user email address", + "name": "email", + "type": "string" }, { "description": "true if user is default, false otherwise", @@ -81301,28 +81803,33 @@ "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user ID", + "name": "id", "type": "string" }, { @@ -81331,28 +81838,28 @@ "type": "integer" }, { - "description": "the user ID", - "name": "id", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -81361,61 +81868,76 @@ "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the name of the role", + "name": "rolename", "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" } ], "type": "list" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { @@ -81424,467 +81946,395 @@ "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, + {}, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "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 owned by account", - "name": "cputotal", - "type": "long" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, - {}, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the 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 account", - "name": "vpcavailable", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", "type": "integer" - } - ] - }, - { - "description": "Revert VM from a vmsnapshot.", - "isasync": true, - "name": "revertToVMSnapshot", - "params": [ + }, { - "description": "The ID of the vm snapshot", - "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": true, - "type": "uuid" - } - ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "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 date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + } + ] + }, + { + "description": "Revert VM from a vmsnapshot.", + "isasync": true, + "name": "revertToVMSnapshot", + "params": [ { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "The ID of the vm snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": true, + "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,importUnmanagedInstance,importVm", + "response": [ + { + "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 hypervisor on which the template runs", + "name": "hypervisor", + "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain name of the affinity group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "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", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { @@ -81893,233 +82343,116 @@ "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, {}, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, { "description": "the read (IO) of disk on the VM", "name": "diskioread", "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { "description": "Guest vm Boot Type", "name": "boottype", "type": "string" }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, { "description": "the type of the template for the virtual machine", "name": "templatetype", "type": "string" }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the account owning the security group", - "name": "account", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, { "description": "the list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", "type": "set" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "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", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -82128,18 +82461,18 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -82158,64 +82491,96 @@ "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": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", "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 protocol of the security group rule", - "name": "protocol", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "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": "the description of the security group", - "name": "description", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { "description": "the protocol of the security group rule", @@ -82223,8 +82588,8 @@ "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" }, { @@ -82232,38 +82597,23 @@ "name": "endport", "type": "integer" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -82272,13 +82622,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -82287,8 +82637,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -82297,8 +82647,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], @@ -82309,6 +82659,11 @@ "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", @@ -82318,26 +82673,204 @@ "description": "the id of the security group rule", "name": "ruleid", "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the name of the security group", + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the affinity group", "name": "name", "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": "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 account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" } ], "type": "set" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "true if 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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + {}, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the 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": "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" }, { @@ -82345,54 +82878,104 @@ "name": "networkkbsread", "type": "long" }, - {}, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, { "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, + {}, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -82401,14 +82984,9 @@ "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the type of the nic", @@ -82416,98 +82994,103 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "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 ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -82519,68 +83102,123 @@ "type": "set" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "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": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the ID of the 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 host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" } ], @@ -82601,46 +83239,46 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the ID of the host tag", "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the host tag", + "name": "name", "type": "string" }, + {}, { "description": "the host ID of the host tag", "name": "hostid", "type": "long" }, - {}, - {}, { - "description": "the name of the host tag", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -82649,6 +83287,13 @@ "isasync": true, "name": "addGuestOs", "params": [ + { + "description": "Map of (key/value pairs)", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, { "description": "Unique display name for Guest OS", "length": 255, @@ -82665,11 +83310,11 @@ "type": "uuid" }, { - "description": "Map of (key/value pairs)", + "description": "Optional name for Guest OS", "length": 255, - "name": "details", + "name": "name", "required": false, - "type": "map" + "type": "string" }, { "description": "whether this guest OS is available for end users", @@ -82677,33 +83322,25 @@ "name": "forDisplay", "required": false, "type": "boolean" - }, - { - "description": "Optional name for Guest OS", - "length": 255, - "name": "name", - "required": false, - "type": "string" } ], "related": "", "response": [ - { - "description": "the name/description of the OS type", - "name": "description", - "type": "string" - }, { "description": "is the guest OS visible for the users", "name": "fordisplay", "type": "boolean" }, { - "description": "the name of the OS type", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the OS category", + "name": "oscategoryname", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -82714,27 +83351,28 @@ "name": "id", "type": "string" }, - { - "description": "the name of the OS category", - "name": "oscategoryname", - "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": "is the guest OS user defined", "name": "isuserdefined", "type": "boolean" }, - {} + {}, + { + "description": "the name/description of the OS type", + "name": "description", + "type": "string" + }, + {}, + { + "description": "the name of the OS type", + "name": "name", + "type": "string" + } ], "since": "4.4.0" }, @@ -82744,56 +83382,61 @@ "name": "addAnnotation", "params": [ { - "description": "the annotation is visible for admins only", + "description": "the annotation text", "length": 255, - "name": "adminsonly", + "name": "annotation", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "string" }, { - "description": "the id of the entity to annotate", + "description": "the annotation is visible for admins only", "length": 255, - "name": "entityid", + "name": "adminsonly", "required": false, - "type": "string" + "since": "4.16.0", + "type": "boolean" }, { - "description": "the annotation text", + "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": "annotation", + "name": "entitytype", "required": false, "type": "string" }, { - "description": "The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER", + "description": "the id of the entity to annotate", "length": 255, - "name": "entitytype", + "name": "entityid", "required": false, "type": "string" } ], "related": "removeAnnotation,updateAnnotationVisibility", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the name of the entity to which this annotation pertains", "name": "entityname", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", + "description": "the creation timestamp for this annotation", + "name": "created", "type": "date" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "The username of the user that entered the annotation", + "name": "username", + "type": "string" + }, + { + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { @@ -82801,11 +83444,10 @@ "name": "adminsonly", "type": "boolean" }, - {}, { - "description": "The username of the user that entered the annotation", - "name": "username", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "The (uu)id of the user that entered the annotation", @@ -82813,23 +83455,19 @@ "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" - }, - { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { @@ -82855,27 +83493,27 @@ } ], "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.4.0" @@ -82886,18 +83524,11 @@ "name": "createTungstenFabricServiceGroup", "params": [ { - "description": "Tungsten-Fabric service group name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Tungsten-Fabric service group protocol", + "description": "Tungsten-Fabric service group start port", "length": 255, - "name": "protocol", + "name": "startport", "required": true, - "type": "string" + "type": "integer" }, { "description": "Tungsten-Fabric service group end port", @@ -82915,62 +83546,69 @@ "type": "uuid" }, { - "description": "Tungsten-Fabric service group start port", + "description": "Tungsten-Fabric service group name", "length": 255, - "name": "startport", + "name": "name", "required": true, - "type": "integer" + "type": "string" + }, + { + "description": "Tungsten-Fabric service group protocol", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" } ], "related": "", "response": [ - { - "description": "Tungsten-Fabric service group start port", - "name": "startport", - "type": "int" - }, { "description": "Tungsten-Fabric service group uuid", "name": "uuid", "type": "string" }, - { - "description": "Tungsten-Fabric service group end port", - "name": "endport", - "type": "int" - }, {}, { "description": "Tungsten-Fabric service group name", "name": "name", "type": "string" }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric service group protocol", + "name": "protocol", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "Tungsten-Fabric service group end port", + "name": "endport", + "type": "int" + }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, - { - "description": "Tungsten-Fabric service group protocol", - "name": "protocol", - "type": "string" - } + {} ] }, { @@ -82979,40 +83617,46 @@ "name": "registerIso", "params": [ { - "description": "Register ISO for the project", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "ispublic", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if you want this ISO to be featured", + "description": "an optional account name. Must be used with domainId.", "length": 255, - "name": "isfeatured", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "true if password reset feature is supported; default is false", "length": 255, - "name": "directdownload", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "the display text of the ISO, defaults to the 'name'", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "ispublic", + "name": "directdownload", "required": false, "type": "boolean" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "Image store UUID", "length": 255, - "name": "bootable", + "name": "imagestoreuuid", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the name of the ISO", @@ -83021,6 +83665,20 @@ "required": true, "type": "string" }, + { + "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": "true if the ISO or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" + }, { "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", "length": 255, @@ -83030,32 +83688,34 @@ "type": "uuid" }, { - "description": "the display text of the ISO, defaults to the 'name'", - "length": 4096, - "name": "displaytext", + "description": "the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", "required": false, "type": "string" }, { - "description": "an optional account name. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the URL to where the ISO is currently being hosted", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { - "description": "true if password reset feature is supported; default is false", + "description": "Register ISO for the project", "length": 255, - "name": "passwordenabled", + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "isextractable", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the ID of the zone you wish to register the ISO to.", @@ -83066,67 +83726,105 @@ "type": "uuid" }, { - "description": "the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "true if you want this ISO to be featured", "length": 255, - "name": "checksum", + "name": "isfeatured", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "isdynamicallyscalable", + "name": "bootable", "required": false, "type": "boolean" + } + ], + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "the account name to which the template belongs", + "name": "account", + "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 processor bit size", + "name": "bits", + "type": "int" }, { - "description": "Image store UUID", - "length": 255, - "name": "imagestoreuuid", - "required": false, + "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 format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the URL to where the ISO is currently being hosted", - "length": 2048, - "name": "url", - "required": true, + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" - } - ], - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ + }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "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": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { @@ -83135,58 +83833,69 @@ "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the ID of the zone for this template", + "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": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, + {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { @@ -83195,9 +83904,9 @@ "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 template ID", @@ -83205,42 +83914,72 @@ "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the 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": "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -83249,185 +83988,84 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, - {}, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" - }, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the size of the template", - "name": "size", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, - { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, + {}, { "description": "the ID of the OS type for this template.", "name": "ostypeid", "type": "string" }, { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "checksum of the template", - "name": "checksum", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", "type": "map" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - {} + } ] }, { @@ -83436,53 +84074,52 @@ "name": "listCiscoAsa1000vResources", "params": [ { - "description": "the Physical Network ID", + "description": "Cisco ASA 1000v resource ID", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", "required": false, "type": "uuid" }, { - "description": "", + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", "length": 255, - "name": "pagesize", + "name": "hostname", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Cisco ASA 1000v resource ID", + "description": "", "length": 255, - "name": "resourceid", - "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "description": "the Physical Network ID", "length": 255, - "name": "hostname", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" } ], "related": "addCiscoAsa1000vResource", "response": [ - {}, {}, { "description": "the UUID of the latest async job acting on this object", @@ -83491,14 +84128,15 @@ }, {}, {}, + {}, + {}, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - {}, - {} + } ] }, { @@ -83507,19 +84145,19 @@ "name": "deployNetscalerVpx", "params": [ { - "description": "the ID of the service offering for the virtual machine", + "description": "availability zone for the virtual machine", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "The network this ip address should be associated to.", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" }, { @@ -83531,19 +84169,24 @@ "type": "uuid" }, { - "description": "availability zone for the virtual machine", + "description": "The network this ip address should be associated to.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, "type": "uuid" } ], "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter", "response": [ { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { @@ -83551,26 +84194,31 @@ "name": "lbdevicecapacity", "type": "long" }, - {}, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" }, + {}, { "description": "device name", "name": "lbdevicename", "type": "string" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" }, { "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", @@ -83578,29 +84226,34 @@ "type": "list" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "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", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", "type": "boolean" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + { + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { "description": "public IP of the NetScaler representing GSLB site", @@ -83609,23 +84262,8 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "device state", - "name": "lbdevicestate", - "type": "string" - }, - { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" } ] @@ -83646,8 +84284,8 @@ "related": "", "response": [ { - "description": "graceallowed", - "name": "graceallowed", + "description": "compression", + "name": "compression", "type": "string" }, { @@ -83656,36 +84294,36 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "deduplication", - "name": "deduplication", + "description": "the name of the volume", + "name": "name", "type": "string" }, { - "description": "the id of the volume", - "name": "id", + "description": "graceallowed", + "name": "graceallowed", "type": "string" }, { - "description": "the name of the volume", - "name": "name", + "description": "deduplication", + "name": "deduplication", "type": "string" }, { - "description": "compression", - "name": "compression", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -83704,16 +84342,13 @@ } ], "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", @@ -83724,8 +84359,11 @@ "name": "jobstatus", "type": "integer" }, - {}, - {} + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -83734,17 +84372,9 @@ "name": "addBaremetalPxeKickStartServer", "params": [ { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "Tftp root directory of PXE server", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "tftpdir", + "name": "password", "required": true, "type": "string" }, @@ -83756,18 +84386,27 @@ "type": "string" }, { - "description": "URL of the external pxe device", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "url", + "name": "tftpdir", "required": true, "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "the Physical Network ID", "length": 255, - "name": "password", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" + }, + { + "description": "Pod Id", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { "description": "type of pxe device", @@ -83777,51 +84416,50 @@ "type": "string" }, { - "description": "Pod Id", + "description": "URL of the external pxe device", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "name": "url", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "url", + "name": "url", "type": "string" }, { - "description": "device id of ", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tftp root directory of PXE server", + "name": "tftpdir", + "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", "type": "string" }, - {}, { - "description": "url", - "name": "url", + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {} ] @@ -83831,14 +84469,6 @@ "isasync": false, "name": "listNiciraNvpDevices", "params": [ - { - "description": "nicira nvp device ID", - "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", - "required": false, - "type": "uuid" - }, { "description": "the Physical Network ID", "length": 255, @@ -83857,48 +84487,63 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "nicira nvp device ID", + "length": 255, + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "required": false, + "type": "uuid" } ], "related": "addNiciraNvpDevice", "response": [ { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" }, { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, { @@ -83911,18 +84556,11 @@ "name": "hostname", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "name of the provider", - "name": "provider", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" - }, - {} + } ] }, { @@ -83938,13 +84576,6 @@ "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -83967,6 +84598,13 @@ "since": "4.3", "type": "string" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -83977,30 +84615,25 @@ ], "related": "", "response": [ - {}, { - "description": "the date and time the alert was sent", - "name": "sent", - "type": "date" - }, - { - "description": "the id of the alert", - "name": "id", + "description": "description of the alert", + "name": "description", "type": "string" }, { - "description": "the name of the alert", - "name": "name", - "type": "string" + "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", + "name": "type", + "type": "short" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "description of the alert", - "name": "description", + "description": "the id of the alert", + "name": "id", "type": "string" }, {}, @@ -84010,9 +84643,14 @@ "type": "string" }, { - "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", - "name": "type", - "type": "short" + "description": "the name of the alert", + "name": "name", + "type": "string" + }, + { + "description": "the date and time the alert was sent", + "name": "sent", + "type": "date" } ] }, @@ -84022,66 +84660,57 @@ "name": "deployVirtualMachine", "params": [ { - "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", - "length": 255, - "name": "rootdisksize", - "required": false, - "since": "4.4", - "type": "long" - }, - { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "nicmultiqueuenumber", "required": false, - "since": "4.13", - "type": "uuid" + "since": "4.18", + "type": "integer" }, { - "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": "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": "keyboard", + "name": "affinitygroupnames", + "related": "", "required": false, - "type": "string" + "type": "list" }, { - "description": "used to specify the vApp properties.", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "properties", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.15", - "type": "map" + "type": "list" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering", + "name": "keypair", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ip address for default vm's network", + "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": "ipaddress", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "description": "Deploy vm for the project", "length": 255, - "name": "details", + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", "required": false, - "since": "4.3", - "type": "map" + "type": "uuid" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.", - "length": 1048576, - "name": "userdata", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "length": 255, + "name": "size", "required": false, - "type": "string" + "type": "long" }, { "description": "an optional account for the virtual machine. Must be used with domainId.", @@ -84091,24 +84720,18 @@ "type": "string" }, { - "description": "host name for the virtual machine", - "length": 255, - "name": "name", - "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": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup", + "name": "affinitygroupids", + "related": "", "required": false, "type": "list" }, @@ -84121,18 +84744,20 @@ "type": "list" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "the ID of the Userdata", "length": 255, - "name": "dynamicscalingenabled", + "name": "userdataid", + "related": "", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.18", + "type": "uuid" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "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": "keypair", + "name": "bootmode", "required": false, + "since": "4.14.0.0", "type": "string" }, { @@ -84144,111 +84769,108 @@ "type": "list" }, { - "description": "the ID of the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "Enable packed virtqueues or not.", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "nicpackedvirtqueuesenabled", "required": false, - "type": "list" + "since": "4.18", + "type": "boolean" }, { - "description": "the ipv6 address for default vm's network", + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "ip6address", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "since": "4.13", + "type": "uuid" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "description": "true if start vm after creating; defaulted to true if not specified", + "length": 255, + "name": "startvm", "required": false, - "since": "4.12", - "type": "string" + "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": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "dynamicscalingenabled", "required": false, - "type": "map" + "since": "4.16", + "type": "boolean" }, { - "description": "the ID of the Userdata", + "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": "userdataid", - "related": "", + "name": "overridediskofferingid", + "related": "createDiskOffering", "required": false, - "since": "4.18", + "since": "4.17", "type": "uuid" }, { - "description": "Controls specific policies on IO", + "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": "iodriverpolicy", + "name": "diskofferingid", + "related": "createDiskOffering", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the template for the virtual machine", + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, + "name": "clusterid", + "related": "addCluster", + "required": false, + "since": "4.13", "type": "uuid" }, { - "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "hypervisor", + "name": "password", "required": false, + "since": "4.19.0.0", "type": "string" }, { - "description": "The number of queues for multiqueue NICs.", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "nicmultiqueuenumber", + "name": "details", "required": false, - "since": "4.18", - "type": "integer" + "since": "4.3", + "type": "map" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "host name for the virtual machine", "length": 255, - "name": "startvm", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", + "description": "an optional group for the virtual machine", "length": 255, - "name": "iptonetworklist", + "name": "group", "required": false, - "type": "map" + "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "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": "userdatadetails", + "name": "securitygroupnames", + "related": "createSecurityGroup", "required": false, - "since": "4.18", - "type": "map" + "type": "list" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "password", + "name": "copyimagetags", "required": false, - "since": "4.19.0.0", - "type": "string" + "since": "4.13", + "type": "boolean" }, { "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", @@ -84259,140 +84881,157 @@ "type": "string" }, { - "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "description": "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": "iothreadsenabled", + "name": "keyboard", + "required": false, + "type": "string" + }, + { + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", "required": false, + "since": "4.2", "type": "boolean" }, { - "description": "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": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, { - "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "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": "datadiskofferinglist", + "name": "rootdisksize", "required": false, - "since": "4.11", - "type": "map" + "since": "4.4", + "type": "long" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "description": "availability zone for the virtual machine", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "since": "4.13", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" }, { - "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": "the ID of the template for the virtual machine", "length": 255, - "name": "nicnetworklist", - "required": false, - "since": "4.15", - "type": "map" + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "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": "customid", + "name": "dhcpoptionsnetworklist", "required": false, - "type": "string" + "type": "map" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "iothreadsenabled", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "Enable packed virtqueues or not.", + "description": "the ip address for default vm's network", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "ipaddress", "required": false, - "since": "4.18", - "type": "boolean" + "type": "string" }, { - "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", + "description": "Controls specific policies on IO", "length": 255, - "name": "overridediskofferingid", - "related": "createDiskOffering", + "name": "iodriverpolicy", "required": false, - "since": "4.17", - "type": "uuid" + "type": "string" }, { - "description": "an optional group for the virtual machine", + "description": "used to specify the vApp properties.", "length": 255, - "name": "group", + "name": "properties", "required": false, - "type": "string" + "since": "4.15", + "type": "map" }, { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "boottype", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", "required": false, - "since": "4.14.0.0", + "since": "4.12", "type": "string" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "description": "the mac address for default vm's network", "length": 255, - "name": "affinitygroupnames", - "related": "", + "name": "macaddress", "required": false, - "type": "list" + "type": "string" }, { - "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "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": "availability zone for the virtual machine", + "description": "the ipv6 address for default vm's network", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "ip6address", + "required": false, + "type": "string" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "displayvm", + "name": "bootintosetup", "required": false, - "since": "4.2", + "since": "4.15.0.0", "type": "boolean" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "copyimagetags", + "name": "customid", "required": false, - "since": "4.13", - "type": "boolean" + "type": "string" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "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": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, + { + "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": "an optional user generated name for the virtual machine", "length": 255, @@ -84401,189 +85040,328 @@ "type": "string" }, { - "description": "Deploy vm for the project", + "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": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "datadiskofferinglist", "required": false, - "type": "uuid" + "since": "4.11", + "type": "map" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", - "length": 255, - "name": "size", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.", + "length": 1048576, + "name": "userdata", "required": false, - "type": "long" + "type": "string" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "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": "bootintosetup", + "name": "iptonetworklist", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "type": "map" } ], "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "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 list of resource tags associated", + "name": "tags", "response": [ { - "description": "the account owning the security group", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "tag value", + "name": "value", "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 name of the security group", - "name": "domain", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + {}, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "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 updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the ID of the 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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -84593,29 +85371,24 @@ "name": "key", "type": "string" }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -84623,33 +85396,38 @@ "name": "domain", "type": "string" }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, { "description": "customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" + "description": "the 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 ID of the security group", @@ -84657,23 +85435,8 @@ "type": "string" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { "description": "the code for the ICMP message response", @@ -84681,9 +85444,9 @@ "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { "description": "the starting IP of the security group rule", @@ -84695,53 +85458,43 @@ "name": "cidr", "type": "string" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "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" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -84750,22 +85503,27 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the protocol of the security group rule", @@ -84773,94 +85531,168 @@ "type": "string" }, { - "description": "the ending IP of the security group rule ", + "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 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 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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" } ], "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" } ], "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "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 target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "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": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { @@ -84868,593 +85700,399 @@ "name": "hasannotations", "type": "boolean" }, - {}, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - {}, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the name of the disk offering of the virtual machine. 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 availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "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 name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - {}, - { - "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" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "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 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", + "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 project name of the affinity group", - "name": "project", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ + }, { - "description": "resource type", - "name": "resourcetype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "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": "tag value", - "name": "value", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], "type": "set" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, + {}, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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 service offering of the virtual machine", - "name": "serviceofferingid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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 netmask of the nic", - "name": "netmask", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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 (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the type of the nic", + "description": "the type of the affinity group", "name": "type", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" } ] @@ -85465,27 +86103,27 @@ "name": "upgradeRouterTemplate", "params": [ { - "description": "upgrades all routers within the specified cluster", + "description": "upgrades all routers owned by the specified domain", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "upgrades all routers within the specified pod", + "description": "upgrades all routers owned by the specified account", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "upgrades all routers owned by the specified account", + "description": "upgrades router with the specified Id", "length": 255, - "name": "account", + "name": "id", + "related": "destroyRouter,listRouters", "required": false, - "type": "string" + "type": "uuid" }, { "description": "upgrades all routers within the specified zone", @@ -85496,35 +86134,35 @@ "type": "uuid" }, { - "description": "upgrades router with the specified Id", + "description": "upgrades all routers within the specified cluster", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, { - "description": "upgrades all routers owned by the specified domain", + "description": "upgrades all routers within the specified pod", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "podid", + "related": "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ] }, @@ -85537,74 +86175,99 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } ], - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "response": [ { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, {}, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "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": "capabilities of the host", - "name": "capabilities", + "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": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "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 amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "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 host hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the host version", - "name": "version", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, { "description": "GPU cards present in the host", "name": "gpugroup", @@ -85618,24 +86281,14 @@ "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, { "description": "Video RAM for this vGPU type", "name": "videoram", "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { @@ -85643,19 +86296,29 @@ "name": "vgputype", "type": "string" }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, { "description": "Maximum Y resolution per display", "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" } ], @@ -85665,74 +86328,64 @@ "type": "list" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "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 CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the name of the host", + "name": "name", "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 Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { "description": "the ID of the host", @@ -85740,105 +86393,94 @@ "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "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" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, - {}, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "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 memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { "description": "the state of the host", @@ -85846,29 +86488,24 @@ "type": "status" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "the date and time the host was last pinged", + "name": "lastpinged", "type": "date" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { "description": "the amount of the host's CPU currently allocated in percentage", @@ -85876,44 +86513,45 @@ "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" } ] }, @@ -85923,48 +86561,50 @@ "name": "listVlanIpRanges", "params": [ { - "description": "List by keyword", + "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", "length": 255, - "name": "keyword", + "name": "vlan", "required": false, "type": "string" }, { - "description": "project who will own the VLAN", + "description": "the ID of the VLAN IP range", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "id", + "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, "type": "uuid" }, { - "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", + "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": "account", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the ID of the VLAN IP range", + "description": "the Pod ID of the VLAN IP range", "length": 255, - "name": "id", - "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "vlan", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "true if VLAN is of Virtual type, false if Direct", @@ -85974,49 +86614,47 @@ "type": "boolean" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "account", "required": false, - "type": "uuid" + "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": "physical network id of the VLAN IP range", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "network id of the VLAN IP range", + "description": "project who will own the VLAN", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "the Pod ID of the VLAN IP range", + "description": "List by keyword", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "physical network id of the VLAN IP range", + "description": "network id of the VLAN IP range", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" } @@ -86024,135 +86662,135 @@ "related": "updateVlanIpRange,dedicatePublicIpRange", "response": [ { - "description": "the end ip of the VLAN IP range", - "name": "endip", - "type": "string" - }, - { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, - {}, { "description": "the virtual network for the VLAN IP range", "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the ID of the VLAN IP range", + "name": "id", + "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, {}, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the project id of the vlan range", + "name": "projectid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ] @@ -86163,122 +86801,122 @@ "name": "updateZone", "params": [ { - "description": "the second DNS for the Zone", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "dns2", + "name": "ip6dns1", "required": false, "type": "string" }, { - "description": "the second internal DNS for the Zone", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "internaldns2", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the details for the Zone", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "details", + "name": "internaldns1", "required": false, - "type": "map" + "type": "string" }, { - "description": "sort key of the zone, integer", + "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", "length": 255, - "name": "sortkey", + "name": "domain", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the name of the Zone", + "description": "the dhcp Provider for the Zone", "length": 255, - "name": "name", + "name": "dhcpprovider", "required": false, "type": "string" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "the name of the Zone", "length": 255, - "name": "ip6dns1", + "name": "name", "required": false, "type": "string" }, { - "description": "updates a private zone to public if set, but not vice-versa", + "description": "the second DNS for the Zone", "length": 255, - "name": "ispublic", + "name": "dns2", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the dhcp Provider for the Zone", + "description": "the ID of the Zone", "length": 255, - "name": "dhcpprovider", - "required": false, - "type": "string" + "name": "id", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the first DNS for the Zone", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "dns1", + "name": "internaldns2", "required": false, "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "ip6dns2", + "name": "localstorageenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the dns search order list", + "description": "updates a private zone to public if set, but not vice-versa", "length": 255, - "name": "dnssearchorder", + "name": "ispublic", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "the guest CIDR address for the Zone", + "description": "sort key of the zone, integer", "length": 255, - "name": "guestcidraddress", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "the dns search order list", "length": 255, - "name": "localstorageenabled", + "name": "dnssearchorder", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "the ID of the Zone", + "description": "the first DNS for the Zone", "length": 255, - "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "dns1", + "required": false, + "type": "string" }, { - "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", + "description": "the details for the Zone", "length": 255, - "name": "domain", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "allocationstate", + "name": "guestcidraddress", "required": false, "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "internaldns1", + "name": "ip6dns2", "required": false, "type": "string" } @@ -86286,29 +86924,8 @@ "related": "createZone,listZones,listZones", "response": [ { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" - }, - { - "description": "Zone description", - "name": "description", - "type": "string" - }, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - {}, - { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { @@ -86317,161 +86934,110 @@ "type": "resourceiconresponse" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "the type of the zone - core or edge", - "name": "type", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", "type": "boolean" }, { - "description": "Zone id", - "name": "id", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, + {}, + {}, { "description": "the second IPv6 DNS for the Zone", "name": "ip6dns2", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" + }, + { + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { @@ -86479,8 +87045,18 @@ "name": "capacity", "response": [ { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { @@ -86489,61 +87065,113 @@ "type": "long" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { "description": "the capacity currently in use", "name": "capacityused", "type": "long" }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, { "description": "the capacity name", "name": "name", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Zone name", + "name": "zonename", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of resource tags associated with zone.", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "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 account associated with the tag", + "name": "account", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "Zone id", + "name": "id", + "type": "string" + }, + { + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { @@ -86552,8 +87180,18 @@ "type": "string" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" + }, + { + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", + "type": "string" + }, + { + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" } ] @@ -86563,14 +87201,6 @@ "isasync": true, "name": "extractVolume", "params": [ - { - "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, @@ -86592,18 +87222,37 @@ "name": "url", "required": false, "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" } ], "related": "downloadImageStoreObject,extractTemplate", "response": [ { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "the upload id of extracted object", + "name": "extractId", + "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the account id to which the extracted object belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { @@ -86617,19 +87266,14 @@ "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, - { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { "description": "zone ID the object was extracted from", @@ -86637,47 +87281,41 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the id of extracted object", - "name": "id", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", - "type": "string" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "", + "name": "resultstring", "type": "string" }, + {}, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, - {}, { - "description": "", - "name": "resultstring", + "description": "the id of extracted object", + "name": "id", "type": "string" - }, - {} + } ] }, { @@ -86693,18 +87331,20 @@ "type": "string" }, { - "description": "List by keyword", + "description": "ID of the project", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "list accounts of the project by account name", + "description": "list invitation by user ID", "length": 255, - "name": "account", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list accounts of the project by project role id", @@ -86715,67 +87355,71 @@ "type": "uuid" }, { - "description": "ID of the project", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list invitation by user ID", + "description": "", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "list accounts of the project by account name", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" } ], "related": "activateProject,suspendProject,updateProject", "response": [ { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the id of the project", + "name": "id", "type": "string" }, + {}, { - "description": "the 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 project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { "description": "the domain name where the project belongs to", @@ -86783,30 +87427,30 @@ "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" }, {}, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the total number of vpcs the project can own", @@ -86814,57 +87458,92 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -86873,51 +87552,36 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the 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" } ], "type": "list" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the state of the project", - "name": "state", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { @@ -86926,38 +87590,23 @@ "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { @@ -86966,34 +87615,29 @@ "type": "float" }, { - "description": "the name of the project", - "name": "name", - "type": "string" - }, - { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { "description": "the total primary storage space (in GiB) owned by project", @@ -87001,45 +87645,39 @@ "type": "long" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the name of the project", + "name": "name", "type": "string" }, - {}, - { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, { - "description": "the id of the project", - "name": "id", - "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", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the state of the project", + "name": "state", + "type": "string" } ], "since": "3.0.0" @@ -87049,6 +87687,22 @@ "isasync": true, "name": "updateAutoScalePolicy", "params": [ + { + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "length": 255, + "name": "conditionids", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "the name of the autoscale policy", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", + "type": "string" + }, { "description": "the duration in which the conditions have to be true before action is taken", "length": 255, @@ -87063,14 +87717,6 @@ "required": false, "type": "integer" }, - { - "description": "the name of the autoscale policy", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", - "type": "string" - }, { "description": "the ID of the autoscale policy", "length": 255, @@ -87078,21 +87724,13 @@ "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, "type": "uuid" - }, - { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "length": 255, - "name": "conditionids", - "related": "", - "required": false, - "type": "list" } ], "related": "listAutoScalePolicies", "response": [ { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { @@ -87100,29 +87738,35 @@ "name": "conditions", "type": "list" }, + {}, { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", + "description": "the project id autoscale policy", + "name": "projectid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, { @@ -87131,30 +87775,24 @@ "type": "string" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", + "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 autoscale policy ID", - "name": "id", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, - {}, { - "description": "name of the autoscale policy", - "name": "name", - "type": "string" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, {} ] @@ -87165,284 +87803,284 @@ "name": "createDiskOffering", "params": [ { - "description": "burst bytes read rate of the disk offering", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "bytesreadratemax", + "name": "iopswriteratemax", "required": false, "type": "long" }, { - "description": "Volumes using this offering should be encrypted", - "length": 255, - "name": "encrypt", + "description": "tags for the disk offering", + "length": 4096, + "name": "tags", "required": false, - "since": "4.18", - "type": "boolean" + "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", "length": 255, - "name": "iopswriteratemaxlength", + "name": "disksize", "required": false, "type": "long" }, { - "description": "whether disk offering iops is custom or not", + "description": "the storage type of the disk offering. Values are local and shared.", "length": 255, - "name": "customizediops", + "name": "storagetype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "details to specify disk offering parameters", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "details", + "name": "iopsreadratemax", "required": false, - "since": "4.16", - "type": "map" + "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "iopsreadrate", "required": false, "type": "long" }, { - "description": "bytes read rate of the disk offering", + "description": "name of the disk offering", "length": 255, - "name": "bytesreadrate", - "required": false, - "type": "long" + "name": "name", + "required": true, + "type": "string" }, { - "description": "whether disk offering size is custom or not", + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", "length": 255, - "name": "customized", + "name": "disksizestrictness", "required": false, + "since": "4.17", "type": "boolean" }, { - "description": "burst io requests write rate of the disk offering", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "iopswriteratemax", + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", "required": false, - "type": "long" + "since": "4.15", + "type": "uuid" }, { - "description": "burst bytes write rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "byteswriteratemax", + "name": "iopswriteratemaxlength", "required": false, "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "whether disk offering iops is custom or not", "length": 255, - "name": "byteswriteratemaxlength", + "name": "customizediops", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "name of the disk offering", + "description": "min iops of the disk offering", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "miniops", + "required": false, + "type": "long" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.13", "type": "list" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", + "name": "displayoffering", "required": false, - "since": "4.15", - "type": "uuid" + "type": "boolean" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "cachemode", + "name": "iopswriterate", "required": false, - "since": "4.14", - "type": "string" + "type": "long" }, { - "description": "the storage type of the disk offering. Values are local and shared.", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "storagetype", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "string" + "since": "4.13", + "type": "list" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "bytesreadrate", "required": false, - "type": "integer" + "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "bytesreadratemaxlength", + "name": "provisioningtype", "required": false, - "type": "long" + "type": "string" }, { - "description": "io requests write rate of the disk offering", + "description": "max iops of the disk offering", "length": 255, - "name": "iopswriterate", + "name": "maxiops", "required": false, "type": "long" }, { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "details to specify disk offering parameters", "length": 255, - "name": "displayoffering", + "name": "details", "required": false, - "type": "boolean" + "since": "4.16", + "type": "map" }, { - "description": "tags for the disk offering", - "length": 4096, - "name": "tags", + "description": "Volumes using this offering should be encrypted", + "length": 255, + "name": "encrypt", "required": false, - "type": "string" + "since": "4.18", + "type": "boolean" }, { - "description": "max iops of the disk offering", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "maxiops", + "name": "bytesreadratemax", "required": false, "type": "long" }, { - "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", + "description": "length (in seconds) of the burst", "length": 255, - "name": "disksize", + "name": "byteswriteratemaxlength", "required": false, "type": "long" }, { - "description": "burst requests read rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "iopsreadratemax", + "name": "bytesreadratemaxlength", "required": false, "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "whether disk offering size is custom or not", "length": 255, - "name": "provisioningtype", + "name": "customized", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "hypervisorsnapshotreserve", "required": false, - "type": "list" + "type": "integer" }, { - "description": "bytes write rate of the disk offering", - "length": 255, - "name": "byteswriterate", + "description": "An alternate display text of the disk offering, defaults to 'name'.", + "length": 4096, + "name": "displaytext", "required": false, - "type": "long" + "type": "string" }, { - "description": "io requests read rate of the disk offering", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "iopsreadrate", + "name": "byteswriteratemax", "required": false, "type": "long" }, { - "description": "min iops of the disk offering", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, - "name": "miniops", + "name": "cachemode", "required": false, - "type": "long" + "since": "4.14", + "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": "length (in seconds) of the burst", "length": 255, - "name": "disksizestrictness", + "name": "iopsreadratemaxlength", "required": false, - "since": "4.17", - "type": "boolean" + "type": "long" }, { - "description": "An alternate display text of the disk offering, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", "required": false, - "type": "string" + "type": "long" } ], "related": "", "response": [ + {}, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the name of the disk offering", + "name": "name", "type": "string" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", - "type": "string" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, - {}, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, { "description": "the max iops of the disk offering", @@ -87450,85 +88088,80 @@ "type": "long" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, + {}, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" - }, - { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "the storage type for this disk offering", + "name": "storagetype", + "type": "string" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" }, - {}, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "unique ID of the disk offering", - "name": "id", - "type": "string" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { "description": "length (in seconds) of the burst", @@ -87536,9 +88169,9 @@ "type": "long" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" }, { "description": "burst io requests read rate of the disk offering", @@ -87546,19 +88179,24 @@ "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", @@ -87566,13 +88204,13 @@ "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "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": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { @@ -87581,9 +88219,9 @@ "type": "boolean" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" } ] }, @@ -87601,61 +88239,50 @@ "type": "boolean" }, { - "description": "the cluster id the disk volume belongs to", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "the name of the disk volume", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "name", "required": false, - "since": "4.3", "type": "string" }, { - "description": "the IDs of the volumes, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "since": "4.9", - "type": "list" - }, - { - "description": "list volumes on specified host", + "description": "list volumes by disk offering", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "diskofferingid", + "related": "", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the disk volume", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "id", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "type": "uuid" }, { - "description": "the pod id the disk volume belongs to", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -87665,9 +88292,16 @@ "type": "boolean" }, { - "description": "the name of the disk volume", + "description": "", "length": 255, - "name": "name", + "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" }, @@ -87679,364 +88313,343 @@ "type": "integer" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "tags", + "name": "clusterid", + "related": "addCluster", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "", + "description": "the ID of the availability zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the type of disk volume", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "description": "the ID of the virtual machine", "length": 255, - "name": "listsystemvms", + "name": "virtualmachineid", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, - "since": "4.18", - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the disk volume", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the ID of the availability zone", + "description": "list volumes on specified host", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "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 IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "listall", + "name": "ids", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "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": "listDomainChildren,listDomains", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "account", + "name": "retrieveonlyresourcecount", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the type of disk volume", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "type", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, + "since": "4.3", "type": "string" }, { - "description": "list volumes by disk offering", + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "listsystemvms", "required": false, - "since": "4.4", - "type": "uuid" + "since": "4.18", + "type": "boolean" } ], "related": "attachVolume,createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "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 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": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the status of the volume", - "name": "status", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, + {}, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -88044,6 +88657,11 @@ "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", @@ -88055,66 +88673,62 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "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": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, + {}, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -88123,54 +88737,78 @@ "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, - {}, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" } ] @@ -88180,13 +88818,6 @@ "isasync": true, "name": "createLBHealthCheckPolicy", "params": [ - { - "description": "Amount of time between health checks (1 sec - 20940 sec)", - "length": 255, - "name": "intervaltime", - "required": false, - "type": "integer" - }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -88196,26 +88827,18 @@ "type": "boolean" }, { - "description": "the description of the load balancer health check policy", + "description": "Amount of time between health checks (1 sec - 20940 sec)", "length": 255, - "name": "description", + "name": "intervaltime", "required": false, - "type": "string" - }, - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy", + "description": "HTTP ping path", "length": 255, - "name": "unhealthythreshold", + "name": "pingpath", "required": false, - "type": "integer" + "type": "string" }, { "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", @@ -88232,30 +88855,48 @@ "type": "integer" }, { - "description": "HTTP ping path", + "description": "the description of the load balancer health check policy", "length": 255, - "name": "pingpath", + "name": "description", "required": false, "type": "string" + }, + { + "description": "Number of consecutive health check failures before declaring an instance unhealthy", + "length": 255, + "name": "unhealthythreshold", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "updateIpv6FirewallRule", + "required": true, + "type": "uuid" } ], "related": "listLBHealthCheckPolicies", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" }, - {}, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { @@ -88264,43 +88905,50 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, + {}, { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", "type": "int" }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the state of the policy", "name": "state", "type": "string" }, + { + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" + }, { "description": "Time to wait when receiving a response from the health check", "name": "responsetime", "type": "int" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the description of the healthcheck policy", + "name": "description", + "type": "string" }, { "description": "the pingpath of the healthcheck policy", @@ -88313,22 +88961,12 @@ "type": "int" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" } ], "type": "list" - }, - { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" } ], "since": "4.2.0" @@ -88350,18 +88988,19 @@ "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", "response": [ { - "description": "the domain name of the user", - "name": "domain", + "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 user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { @@ -88375,33 +89014,33 @@ "type": "string" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -88410,33 +89049,28 @@ "type": "resourceiconresponse" }, { - "description": "the user email address", - "name": "email", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, { "description": "true if user is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { @@ -88445,16 +89079,25 @@ "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, - {}, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, { "description": "the account type of the user", "name": "accounttype", @@ -88466,21 +89109,16 @@ "type": "integer" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, - {}, { - "description": "the timezone user was created in", - "name": "timezone", + "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" - } + {} ] }, { @@ -88490,14 +89128,10 @@ "params": [], "related": "", "response": [ + {}, { - "description": "the Cloudian connector enabled state", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the Cloudian Management Console base URL", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -88505,13 +89139,17 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the Cloudian connector enabled state", + "name": "enabled", + "type": "boolean" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Cloudian Management Console base URL", + "name": "url", "type": "string" - }, - {} + } ], "since": "4.11.0" }, @@ -88521,18 +89159,20 @@ "name": "listLBHealthCheckPolicies", "params": [ { - "description": "", + "description": "the ID of the load balancer rule", "length": 255, - "name": "pagesize", + "name": "lbruleid", + "related": "updateIpv6FirewallRule", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the load balancer rule", + "description": "the ID of the health check policy", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", + "name": "id", + "related": "listLBHealthCheckPolicies", "required": false, + "since": "4.4", "type": "uuid" }, { @@ -88544,46 +89184,29 @@ "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the health check policy", + "description": "", "length": 255, - "name": "id", - "related": "listLBHealthCheckPolicies", + "name": "page", "required": false, - "since": "4.4", - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ - { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" - }, - { - "description": "the account of the HealthCheck policy", - "name": "account", - "type": "string" - }, - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, { "description": "the domain ID of the HealthCheck policy", "name": "domainid", @@ -88594,28 +89217,33 @@ "name": "jobid", "type": "string" }, + { + "description": "the account of the HealthCheck policy", + "name": "account", + "type": "string" + }, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ + { + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" + }, { "description": "Amount of time between health checks", "name": "healthcheckinterval", "type": "int" }, { - "description": "the description of the healthcheck policy", - "name": "description", + "description": "the LB HealthCheck policy ID", + "name": "id", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the state of the policy", - "name": "state", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { @@ -88624,19 +89252,19 @@ "type": "int" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", + "description": "the description of the healthcheck policy", + "name": "description", "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" + "description": "the state of the policy", + "name": "state", + "type": "string" }, { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "Number of consecutive health check success before declaring an instance healthy", @@ -88646,18 +89274,28 @@ ], "type": "list" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, {}, { "description": "the id of the zone the HealthCheck policy belongs to", "name": "zoneid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" + }, + {} ], "since": "4.2.0" }, @@ -88667,18 +89305,19 @@ "name": "createNetwork", "params": [ { - "description": "Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network", + "description": "the VPC network belongs to", "length": 255, - "name": "acltype", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", + "description": "network domain", "length": 255, - "name": "bypassvlanoverlapcheck", + "name": "networkdomain", "required": false, - "type": "boolean" + "type": "string" }, { "description": "IPV4 address to be assigned to a router in a shared network", @@ -88689,68 +89328,40 @@ "type": "string" }, { - "description": "the display text of the network", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "ID of the network in an external system.", - "length": 255, - "name": "externalid", - "required": false, - "type": "string" - }, - { - "description": "the ID or VID of the network", - "length": 255, - "name": "vlan", - "required": false, - "type": "string" - }, - { - "description": "the network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "the second IPv4 DNS for the network", + "description": "the first IPv4 DNS for the network", "length": 255, - "name": "dns2", + "name": "dns1", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", + "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": "tungstenvirtualrouteruuid", + "name": "sourcenatipaddress", "required": false, + "since": "4.19", "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "MTU to be configured on the network VR's private interface(s)", "length": 255, - "name": "publicmtu", + "name": "privatemtu", "required": false, "since": "4.18.0", "type": "integer" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks", + "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "ip6gateway", + "name": "gateway", "required": false, "type": "string" }, { - "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "Account that will own the network. Account should be under the selected domain", "length": 255, - "name": "gateway", + "name": "account", "required": false, "type": "string" }, @@ -88769,14 +89380,6 @@ "required": false, "type": "boolean" }, - { - "description": "the first IPv6 DNS for the network", - "length": 255, - "name": "ip6dns1", - "required": false, - "since": "4.18.0", - "type": "string" - }, { "description": "Network ACL ID associated for the network", "length": 255, @@ -88785,30 +89388,6 @@ "required": false, "type": "uuid" }, - { - "description": "the first IPv4 DNS for the network", - "length": 255, - "name": "dns1", - "required": false, - "since": "4.18.0", - "type": "string" - }, - { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", - "length": 255, - "name": "hideipaddressusage", - "required": false, - "type": "boolean" - }, - { - "description": "The network this network is associated to. only available if create a Shared network", - "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.17.0", - "type": "uuid" - }, { "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", "length": 255, @@ -88817,11 +89396,12 @@ "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "an optional project for the network", "length": 255, - "name": "endipv6", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the physical network ID the network belongs to", @@ -88832,27 +89412,26 @@ "type": "uuid" }, { - "description": "the name of the network", + "description": "IPV6 address to be assigned to a router in a shared network", "length": 255, - "name": "name", - "required": true, + "name": "routeripv6", + "required": false, + "since": "4.16", "type": "string" }, { - "description": "IPV6 address to be assigned to a router in a shared network", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "routeripv6", + "name": "startipv6", "required": false, - "since": "4.16", "type": "string" }, { - "description": "the VPC network belongs to", + "description": "ID of the network in an external system.", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "externalid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the zone ID for the network", @@ -88863,91 +89442,90 @@ "type": "uuid" }, { - "description": "network domain", + "description": "the first IPv6 DNS for the network", "length": 255, - "name": "networkdomain", + "name": "ip6dns1", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", "length": 255, - "name": "ip6cidr", + "name": "bypassvlanoverlapcheck", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the isolated private VLAN type for this network", + "description": "Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network", "length": 255, - "name": "isolatedpvlantype", + "name": "acltype", "required": false, "type": "string" }, { - "description": "Account that will own the network. Account should be under the selected domain", + "description": "the gateway of the IPv6 network. Required for Shared networks", "length": 255, - "name": "account", + "name": "ip6gateway", "required": false, "type": "string" }, { - "description": "Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified", + "description": "the name of the network", "length": 255, - "name": "subdomainaccess", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "the display text of the network", "length": 255, - "name": "netmask", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the isolated private VLAN for this network", "length": 255, - "name": "startipv6", + "name": "isolatedpvlan", "required": false, "type": "string" }, { - "description": "the second IPv6 DNS for the network", + "description": "the network offering ID", "length": 255, - "name": "ip6dns2", - "required": false, - "since": "4.18.0", - "type": "string" + "name": "networkofferingid", + "related": "listNetworkOfferings", + "required": true, + "type": "uuid" }, { - "description": "MTU to be configured on the network VR's private interface(s)", + "description": "Tungsten-Fabric virtual router the network belongs to", "length": 255, - "name": "privatemtu", + "name": "tungstenvirtualrouteruuid", "required": false, - "since": "4.18.0", - "type": "integer" + "type": "string" }, { - "description": "an optional project for the network", + "description": "the second IPv4 DNS for the network", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "dns2", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "the isolated private VLAN for this network", + "description": "the isolated private VLAN type for this network", "length": 255, - "name": "isolatedpvlan", + "name": "isolatedpvlantype", "required": false, "type": "string" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "sourcenatipaddress", + "name": "netmask", "required": false, - "since": "4.19", "type": "string" }, { @@ -88956,73 +89534,83 @@ "name": "startip", "required": false, "type": "string" - } - ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "response": [ + }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", + "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": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified", + "length": 255, + "name": "subdomainaccess", + "required": false, "type": "boolean" }, { - "description": "the type of the network", - "name": "type", - "type": "string" - }, - { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "The network this network is associated to. only available if create a Shared network", + "length": 255, + "name": "associatednetworkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "since": "4.17.0", + "type": "uuid" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the second IPv6 DNS for the network", + "length": 255, + "name": "ip6dns2", + "required": false, + "since": "4.18.0", "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": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "length": 255, + "name": "hideipaddressusage", + "required": false, + "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the ID or VID of the network", + "length": 255, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the CIDR of IPv6 network, must be at least /64", + "length": 255, + "name": "ip6cidr", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the ending IPv6 address in the IPv6 network range", + "length": 255, + "name": "endipv6", + "required": false, "type": "string" - }, + } + ], + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "response": [ { - "description": "related to what other network configuration", - "name": "related", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { @@ -89031,115 +89619,78 @@ "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" - }, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { "description": "the list of services", "name": "service", "response": [ { - "description": "the list of capabilities", - "name": "capability", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "the capability name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the capability value", - "name": "value", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", @@ -89154,25 +89705,27 @@ "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": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { - "description": "state of the network provider", - "name": "state", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the capability name", + "name": "name", "type": "string" } ], @@ -89187,86 +89740,50 @@ "type": "list" }, { - "description": "the id of the network", - "name": "id", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the name of the network", + "name": "name", + "type": "string" }, + {}, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { "description": "the ID of the Network associated with this private gateway", @@ -89274,13 +89791,13 @@ "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { @@ -89288,85 +89805,90 @@ "name": "dns2", "type": "string" }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, { "description": "MTU configured on the network VR's public facing interfaces", "name": "publicmtu", "type": "integer" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "acl type - access type to the network", + "name": "acltype", "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 ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the owner of the network", - "name": "account", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" }, { "description": "the domain name of the network owner", @@ -89374,45 +89896,43 @@ "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "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": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", + "description": "the id of the network", + "name": "id", "type": "string" }, - {}, { - "description": "the network domain", - "name": "networkdomain", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { @@ -89420,45 +89940,163 @@ "name": "ip6dns2", "type": "string" }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, { "description": "true if network is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "tag 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": "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": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" } ] }, @@ -89468,55 +90106,43 @@ "name": "listNetworkOfferings", "params": [ { - "description": "list by traffic type", + "description": "list network offerings by ID", "length": 255, - "name": "traffictype", + "name": "id", + "related": "listNetworkOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", + "description": "list network offerings available for network creation in specific domain", "length": 255, - "name": "sourcenatsupported", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "since": "4.13", + "type": "uuid" }, { - "description": "List by keyword", + "description": "the availability of network offering. Default value is required", "length": 255, - "name": "keyword", + "name": "availability", "required": false, "type": "string" }, { - "description": "list network offerings by state", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, - { - "description": "the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "list network offerings by guest type: shared or isolated", - "length": 255, - "name": "guestiptype", - "required": false, - "type": "string" - }, { "description": "list network offerings available for network creation in specific zone", "length": 255, @@ -89526,47 +90152,44 @@ "type": "uuid" }, { - "description": "list network offerings available for network creation in specific domain", + "description": "true if need to list only network offerings which support specifying ip ranges", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "specifyipranges", "required": false, - "since": "4.13", - "type": "uuid" + "type": "boolean" }, { - "description": "true if offering has tags specified", + "description": "list network offerings by state", "length": 255, - "name": "istagged", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network offerings by tags", - "length": 4096, - "name": "tags", + "description": "list by traffic type", + "length": 255, + "name": "traffictype", "required": false, "type": "string" }, { - "description": "list network offerings by display text", + "description": "list network offerings supporting certain services", "length": 255, - "name": "displaytext", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "list network offerings by ID", + "description": "", "length": 255, - "name": "id", - "related": "listNetworkOfferings", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the network offering can be used only for network creation inside the VPC", + "description": "true if offering has tags specified", "length": 255, - "name": "forvpc", + "name": "istagged", "required": false, "type": "boolean" }, @@ -89578,23 +90201,31 @@ "type": "string" }, { - "description": "list network offerings supporting certain services", + "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": "supportedservices", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the availability of network offering. Default value is required", + "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", "length": 255, - "name": "availability", + "name": "sourcenatsupported", + "required": false, + "type": "boolean" + }, + { + "description": "list network offerings by tags", + "length": 4096, + "name": "tags", "required": false, "type": "string" }, { - "description": "true if need to list only network offerings which support specifying ip ranges", + "description": "true if need to list only default network offerings. Default value is false", "length": 255, - "name": "specifyipranges", + "name": "isdefault", "required": false, "type": "boolean" }, @@ -89606,75 +90237,47 @@ "type": "boolean" }, { - "description": "", + "description": "list network offerings by guest type: shared or isolated", "length": 255, - "name": "pagesize", + "name": "guestiptype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "true if need to list only default network offerings. Default value is false", + "description": "the network offering can be used only for network creation inside the VPC", "length": 255, - "name": "isdefault", + "name": "forvpc", "required": false, "type": "boolean" - } - ], - "related": "", - "response": [ - { - "description": "the date this network offering was created", - "name": "created", - "type": "date" - }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" - }, - { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", - "type": "string" }, { - "description": "an alternate display text of the network offering.", + "description": "list network offerings by display text", + "length": 255, "name": "displaytext", + "required": false, "type": "string" - }, - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" - }, - { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" - }, + } + ], + "related": "", + "response": [ { "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": "can this service capability value can be choosable while creatine network offerings", "name": "canchooseservicecapability", @@ -89684,37 +90287,22 @@ "description": "the capability name", "name": "name", "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" } ], "type": "list" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -89723,19 +90311,24 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" @@ -89744,45 +90337,44 @@ "type": "list" }, { - "description": "availability of the network offering", - "name": "availability", - "type": "string" - }, - { - "description": "the id of the network offering", - "name": "id", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "the name of the network offering", - "name": "name", - "type": "string" + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, - {}, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", "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 zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, {}, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", "type": "boolean" }, { @@ -89791,18 +90383,28 @@ "type": "boolean" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", - "type": "string" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { @@ -89810,49 +90412,85 @@ "name": "domain", "type": "string" }, + {}, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" + }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", + "description": "the id of the network offering", + "name": "id", + "type": "string" + }, + { + "description": "the date this network offering was created", + "name": "created", + "type": "date" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, + { + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the name of the network offering", + "name": "name", + "type": "string" + }, + { + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", + "type": "string" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, { "description": "maximum number of concurrents connections to be handled by lb", "name": "maxconnections", "type": "integer" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "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 ID of the service offering used by virtual router provider", + "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": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" } ] @@ -89870,93 +90508,93 @@ "type": "integer" }, { - "description": "the ID of the domain associated with the pod", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list dedicated pods by affinity group", "length": 255, - "name": "pagesize", + "name": "affinitygroupid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the pod", + "description": "the name of the account associated with the pod. Must be used with domainId.", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "the ID of the domain associated with the pod", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list dedicated pods by affinity group", + "description": "", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the account associated with the pod. Must be used with domainId.", + "description": "the ID of the pod", "length": 255, - "name": "account", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the Name of the Pod", "name": "podname", "type": "string" }, + {}, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "the ID of the Pod", + "name": "podid", "type": "string" }, { - "description": "the ID of the Pod", - "name": "podid", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" }, { - "description": "the domain ID to which the Pod is dedicated", - "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 ID of the dedicated resource", - "name": "id", + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" } ] @@ -89966,21 +90604,6 @@ "isasync": true, "name": "migrateVirtualMachineWithVolume", "params": [ - { - "description": "Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=&migrateto[volume-index].pool=Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume= indicates the UUID of the volume that you want to migrate, and pool= indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", - "length": 255, - "name": "migrateto", - "required": false, - "type": "map" - }, - { - "description": "Destination Host ID to migrate VM to.", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" - }, { "description": "the ID of the virtual machine", "length": 255, @@ -89996,28 +90619,68 @@ "required": false, "since": "4.19.0", "type": "boolean" + }, + { + "description": "Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=&migrateto[volume-index].pool=Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume= indicates the UUID of the volume that you want to migrate, and pool= indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", + "length": 255, + "name": "migrateto", + "required": false, + "type": "map" + }, + { + "description": "Destination Host ID to migrate VM to.", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" } ], "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, + { + "description": "the 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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "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" }, { @@ -90026,13 +90689,165 @@ "type": "integer" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "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": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the 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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + {}, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the project name of the vm", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { @@ -90041,8 +90856,18 @@ "type": "boolean" }, { - "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 state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { @@ -90055,163 +90880,160 @@ "type": "integer" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the 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", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the 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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, { "description": "the ID of the security group", "name": "id", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -90220,28 +91042,53 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the 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 id of the security group rule", "name": "ruleid", @@ -90256,132 +91103,114 @@ "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", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the domain ID of the security group", "name": "domainid", "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, - {}, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { "description": "the outgoing network traffic on the host in KiB", @@ -90389,63 +91218,63 @@ "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "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 state of the virtual machine", - "name": "state", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { @@ -90454,98 +91283,58 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "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": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "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": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "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": " 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 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": "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -90559,48 +91348,48 @@ "type": "boolean" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "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": "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": "MTU configured on the NIC", - "name": "mtu", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -90608,85 +91397,90 @@ "name": "ip6gateway", "type": "string" }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, { "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the 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": "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": "the ip address of the nic", - "name": "ipaddress", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" } ], "type": "set" @@ -90697,69 +91491,13 @@ "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - {}, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "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 name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { @@ -90767,13 +91505,8 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -90782,85 +91515,110 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "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": "tag value", "name": "value", "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "set" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "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 ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { @@ -90869,167 +91627,47 @@ "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "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" } ], "type": "set" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the 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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" } ] }, @@ -91039,63 +91677,55 @@ "name": "listVPCs", "params": [ { - "description": "List by display text of the VPC", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "keyword", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "list VPCs by state", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "state", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "flag to display the resource icon for VPCs", + "description": "list VPC by id", "length": 255, - "name": "showicon", + "name": "id", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list VPC by id", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "id", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list by ID of the VPC offering", "length": 255, - "name": "fordisplay", + "name": "vpcofferingid", + "related": "updateVPCOffering", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", @@ -91105,27 +91735,25 @@ "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list VPCs by restartRequired option", "length": 255, - "name": "account", + "name": "restartrequired", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list by ID of the VPC offering", + "description": "list by name of the VPC", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list by zone", @@ -91136,202 +91764,141 @@ "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "tags", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list VPCs by state", "length": 255, - "name": "isrecursive", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list VPC supporting certain services", "length": 255, - "name": "listall", + "name": "supportedservices", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "list VPC supporting certain services", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "supportedservices", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "list" + "type": "uuid" + }, + { + "description": "List by display text of the VPC", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list by name of the VPC", + "description": "flag to display the resource icon for VPCs", "length": 255, - "name": "name", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list VPCs by restartRequired option", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "restartrequired", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" } ], "related": "createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "the id of the VPC", - "name": "id", - "type": "string" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the name of the VPC", - "name": "name", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "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 domain id of the VPC owner", - "name": "domainid", + "description": "the id of the VPC", + "name": "id", "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", + "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { @@ -91340,83 +91907,184 @@ "type": "boolean" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "the project name of the VPC", + "name": "project", "type": "string" }, - {}, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, { "description": "if this VPC has redundant router", "name": "redundantvpcrouter", "type": "boolean" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", - "type": "string" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -91425,23 +92093,23 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -91451,36 +92119,6 @@ } ], "type": "list" - }, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" - }, - { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" } ] }, @@ -91511,17 +92149,17 @@ "name": "jobid", "type": "string" }, + { + "description": "the ID of the network device", + "name": "id", + "type": "string" + }, {}, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the ID of the network device", - "name": "id", - "type": "string" } ] }, @@ -91531,11 +92169,12 @@ "name": "runDiagnostics", "params": [ { - "description": "The IP/Domain address to test connection to", + "description": "The ID of the system VM instance to diagnose", "length": 255, - "name": "ipaddress", + "name": "targetid", + "related": "migrateSystemVm,startSystemVm", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Additional command line options that apply for each command", @@ -91545,49 +92184,48 @@ "type": "string" }, { - "description": "The ID of the system VM instance to diagnose", + "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", "length": 255, - "name": "targetid", - "related": "migrateSystemVm,startSystemVm", + "name": "type", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", + "description": "The IP/Domain address to test connection to", "length": 255, - "name": "type", + "name": "ipaddress", "required": true, "type": "string" } ], "related": "", "response": [ - { - "description": "the standard output from the command execution", - "name": "stdout", - "type": "string" - }, + {}, { "description": "the command execution return code", "name": "exitcode", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the standard error output from the command execution", "name": "stderr", "type": "string" + }, + { + "description": "the standard output from the command execution", + "name": "stdout", + "type": "string" } ], "since": "4.12.0.0" @@ -91598,23 +92236,31 @@ "name": "updateUser", "params": [ { - "description": "Unique username", + "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": "username", + "name": "mandate2fa", + "required": false, + "since": "4.18.0.0", + "type": "boolean" + }, + { + "description": "The API key for the user. Must be specified with userSecretKey", + "length": 255, + "name": "userapikey", "required": false, "type": "string" }, { - "description": "last name", + "description": "Unique username", "length": 255, - "name": "lastname", + "name": "username", "required": false, "type": "string" }, { - "description": "The secret key for the user. Must be specified with userApiKey", + "description": "email", "length": 255, - "name": "usersecretkey", + "name": "email", "required": false, "type": "string" }, @@ -91626,31 +92272,30 @@ "type": "string" }, { - "description": "The API key for the user. Must be specified with userSecretKey", + "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": "userapikey", + "name": "password", "required": false, "type": "string" }, { - "description": "Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "mandate2fa", + "name": "timezone", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "last name", "length": 255, - "name": "timezone", + "name": "lastname", "required": false, "type": "string" }, { - "description": "email", + "description": "Current password that was being used by the user. You must inform the current password when updating the password.", "length": 255, - "name": "email", + "name": "currentpassword", "required": false, "type": "string" }, @@ -91663,16 +92308,9 @@ "type": "uuid" }, { - "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", - "length": 255, - "name": "password", - "required": false, - "type": "string" - }, - { - "description": "Current password that was being used by the user. You must inform the current password when updating the password.", + "description": "The secret key for the user. Must be specified with userApiKey", "length": 255, - "name": "currentpassword", + "name": "usersecretkey", "required": false, "type": "string" } @@ -91680,49 +92318,55 @@ "related": "createUser,disableUser,enableUser,getUser,listUsers", "response": [ { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" + "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", @@ -91730,45 +92374,38 @@ "type": "integer" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, - {}, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, { "description": "the user state", "name": "state", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "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 boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the user name", - "name": "username", + "description": "the account name of the user", + "name": "account", "type": "string" }, - {}, { - "description": "the name of the role", - "name": "rolename", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { @@ -91777,40 +92414,41 @@ "type": "string" }, { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the account name of the user", - "name": "account", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the user ID", "name": "id", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - } + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + {} ] }, { @@ -91819,11 +92457,12 @@ "name": "restartVPC", "params": [ { - "description": "If cleanup old network elements", + "description": "the id of the VPC", "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" + "name": "id", + "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" }, { "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", @@ -91841,36 +92480,35 @@ "type": "boolean" }, { - "description": "the id of the VPC", + "description": "If cleanup old network elements", "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" + "name": "cleanup", + "required": false, + "type": "boolean" } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -91889,27 +92527,27 @@ } ], "response": [ - {}, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "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" } ] }, @@ -91919,40 +92557,40 @@ "name": "addHost", "params": [ { - "description": "hypervisor type of the host", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "hypervisor", - "required": true, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "the cluster name for the host", + "description": "list of tags to be added to the host", "length": 255, - "name": "clustername", + "name": "hosttags", "required": false, - "type": "string" + "type": "list" }, { - "description": "the cluster ID for the host", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "username", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the host URL", + "description": "the cluster name for the host", "length": 255, - "name": "url", - "required": true, + "name": "clustername", + "required": false, "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "the cluster ID for the host", "length": 255, - "name": "hosttags", + "name": "clusterid", + "related": "addCluster", "required": false, - "type": "list" + "type": "uuid" }, { "description": "the Pod ID for the host", @@ -91970,79 +92608,90 @@ "type": "string" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "the Zone ID for the host", "length": 255, - "name": "username", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "hypervisor type of the host", "length": 255, - "name": "allocationstate", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "the Zone ID for the host", + "description": "the host URL", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "url", "required": true, - "type": "uuid" + "type": "string" } ], - "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "response": [ { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, + {}, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the 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 cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { "description": "the cluster name of the host", @@ -92050,14 +92699,14 @@ "type": "string" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "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", @@ -92065,185 +92714,213 @@ "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "events available for the host", - "name": "events", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "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 incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "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": "the host version", "name": "version", "type": "string" }, - {}, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "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 cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", "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 removed", + "name": "removed", + "type": "date" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, { "description": "the host's currently allocated disk size", "name": "disksizeallocated", "type": "long" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "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", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the 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 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": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the ID of the host", - "name": "id", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the name of the host", + "name": "name", "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": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, { "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", "name": "maxcapacity", @@ -92254,56 +92931,46 @@ "name": "maxheads", "type": "long" }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, { "description": "Maximum no. of vgpu per gpu card (pgpu)", "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "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", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "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": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", @@ -92311,59 +92978,30 @@ "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { "description": "the state of the host", "name": "state", "type": "status" }, + {}, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" - }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod name of the host", - "name": "podname", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" } ] }, @@ -92399,127 +93037,161 @@ "related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "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", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + {}, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, { "description": "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": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the status of the volume", + "name": "status", "type": "string" }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, { "description": "the write (IO) of disk on the vm", "name": "diskiowrite", "type": "long" }, { - "description": "the path of the volume", - "name": "path", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, - {}, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the 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", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "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": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, - {}, { "description": "an alternate display text of the ISO attached to the virtual machine", "name": "isodisplaytext", @@ -92530,33 +93202,33 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -92565,13 +93237,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -92588,159 +93260,130 @@ "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the state of the disk volume", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, + {}, { - "description": "shared or local storage", - "name": "storagetype", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "size of the disk volume", + "name": "size", "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": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "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", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { "description": "volume uuid that is given by virtualisation provider (only for VMware)", @@ -92748,49 +93391,44 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" } ] }, @@ -92800,26 +93438,26 @@ "name": "addBaremetalDhcp", "params": [ { - "description": "the Physical Network ID", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Credentials to reach external dhcp device", + "description": "URL of the external dhcp appliance.", "length": 255, - "name": "password", + "name": "url", "required": true, "type": "string" }, { - "description": "Type of dhcp device", + "description": "the Physical Network ID", "length": 255, - "name": "dhcpservertype", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Credentials to reach external dhcp device", @@ -92829,9 +93467,9 @@ "type": "string" }, { - "description": "URL of the external dhcp appliance.", + "description": "Type of dhcp device", "length": 255, - "name": "url", + "name": "dhcpservertype", "required": true, "type": "string" } @@ -92840,32 +93478,29 @@ "response": [ { "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "name": "dhcpservertype", "type": "string" }, { - "description": "name of the provider", - "name": "dhcpservertype", + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "url", - "name": "url", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "device id of ", - "name": "id", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, + {}, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "url", + "name": "url", "type": "string" }, { @@ -92873,8 +93508,11 @@ "name": "jobstatus", "type": "integer" }, - {}, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -92882,13 +93520,6 @@ "isasync": true, "name": "deleteTungstenFabricApplicationPolicySet", "params": [ - { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -92896,31 +93527,38 @@ "related": "createZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": true, + "type": "string" } ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "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" - }, - {} + } ] }, { @@ -92963,30 +93601,46 @@ ], "related": "revertSnapshot,listSnapshots", "response": [ + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, { "description": "state of the snapshot on the datastore", "name": "datastorestate", "type": "string" }, + {}, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "name of the disk volume", + "name": "volumename", "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 snapshot", + "name": "projectid", + "type": "string" }, { "description": "the type of the snapshot", @@ -92994,19 +93648,19 @@ "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", - "type": "string" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { "description": "valid location types are primary and secondary.", @@ -93014,30 +93668,24 @@ "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, {}, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - { - "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": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" }, - {}, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { @@ -93046,8 +93694,8 @@ "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { @@ -93056,14 +93704,9 @@ "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" - }, - { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { "description": "display name of the os on volume", @@ -93071,23 +93714,23 @@ "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the status of the template", + "name": "status", "type": "string" }, { @@ -93100,33 +93743,33 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -93135,47 +93778,42 @@ "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 account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" - }, - { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "name of the snapshot", + "name": "name", + "type": "string" } ], "since": "4.19.0" @@ -93218,42 +93856,42 @@ "related": "", "response": [ { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the ID of the external firewall", - "name": "id", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the external firewall", + "name": "id", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the zone ID of the external firewall", "name": "zoneid", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -93262,11 +93900,12 @@ "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", + "description": "ID of the user to be promoted/demoted", "length": 255, - "name": "swapowner", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "new Admin account for the project", @@ -93283,12 +93922,11 @@ "type": "string" }, { - "description": "ID of the user to be promoted/demoted", + "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": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers", + "name": "swapowner", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "id of the project to be modified", @@ -93299,167 +93937,132 @@ "type": "uuid" }, { - "description": "name of the project", + "description": "Account level role to be assigned to the user/account : Admin/Regular", "length": 255, - "name": "name", + "name": "roletype", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "Account level role to be assigned to the user/account : Admin/Regular", + "description": "name of the project", "length": 255, - "name": "roletype", + "name": "name", "required": false, + "since": "4.19.0", "type": "string" } ], "related": "activateProject,suspendProject", "response": [ { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, - {}, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", + "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", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the date this project was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the state of the project", - "name": "state", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -93473,28 +94076,23 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the 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" }, { @@ -93503,111 +94101,151 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "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": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, { "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", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, + { + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, { "description": "the total number of public ip addresses allocated for this project", "name": "iptotal", "type": "long" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", "type": "integer" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the id of the project", + "name": "id", "type": "string" } ], @@ -93619,13 +94257,34 @@ "name": "listLoadBalancers", "params": [ { - "description": "the network ID of the source IP address", + "description": "the scheme of the load balancer. Supported value is internal in the current release", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "scheme", + "required": false, + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, + { + "description": "List by 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 objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -93635,11 +94294,11 @@ "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "listall", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { "description": "", @@ -93649,18 +94308,19 @@ "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the load balancer", "length": 255, - "name": "account", + "name": "id", + "related": "updateIpv6FirewallRule", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -93670,18 +94330,12 @@ "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "List resources by tags (key/value pairs)", + "description": "the network ID of the load balancer", "length": 255, - "name": "tags", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "map" + "type": "uuid" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -93692,77 +94346,50 @@ "type": "boolean" }, { - "description": "the source IP address of the load balancer", + "description": "the name of the load balancer", "length": 255, - "name": "sourceipaddress", + "name": "name", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the name of the load balancer", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "the ID of the load balancer", + "description": "the network ID of the source IP address", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule", + "name": "sourceipaddressnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "the scheme of the load balancer. Supported value is internal in the current release", + "description": "the source IP address of the load balancer", "length": 255, - "name": "scheme", + "name": "sourceipaddress", "required": false, "type": "string" - }, - { - "description": "the network ID of the load balancer", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" } ], "related": "createLoadBalancer", "response": [ { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" - }, - { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" - }, - {}, - { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -93771,83 +94398,86 @@ "type": "string" }, { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - }, - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - } - ], - "type": "list" + "description": "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 project id of the Load Balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", + "description": "the list of resource tags associated with the Load Balancer", + "name": "tags", "response": [ { - "description": "the ip address of the instance", - "name": "ipaddress", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the state of the instance", - "name": "state", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the instance ID", - "name": "id", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the name of the instance", - "name": "name", + "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the name of the Load Balancer", - "name": "name", + "description": "the account of the Load Balancer", + "name": "account", "type": "string" }, + {}, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, { @@ -93856,71 +94486,79 @@ "type": "string" }, { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", "response": [ { - "description": "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": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "description": "the state of the load balancer rule", + "name": "state", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + } + ], + "type": "list" + }, + { + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "type": "string" + }, + { + "description": "the project name of the Load Balancer", + "name": "project", + "type": "string" + }, + { + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the state of the instance", + "name": "state", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the instance ID", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the name of the instance", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" } ], "type": "list" + }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" } ], "since": "4.2.0" @@ -93931,48 +94569,46 @@ "name": "listUsers", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "List user by the username", + "description": "List users by state of the user account.", "length": 255, - "name": "username", + "name": "state", "required": false, "type": "string" }, { - "description": "", + "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", "length": 255, - "name": "pagesize", + "name": "accounttype", "required": false, "type": "integer" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List user by ID.", + "description": "flag to display the resource icon for users", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -93982,51 +94618,53 @@ "type": "string" }, { - "description": "List by keyword", + "description": "List user by ID.", "length": 255, - "name": "keyword", + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List user by the username", "length": 255, - "name": "isrecursive", + "name": "username", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "accounttype", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List users by state of the user account.", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "flag to display the resource icon for users", + "description": "", "length": 255, - "name": "showicon", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" } ], "related": "createUser,disableUser,enableUser,getUser", "response": [ { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user state", + "name": "state", "type": "string" }, { @@ -94035,14 +94673,29 @@ "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "true if user has two factor authentication enabled", @@ -94055,28 +94708,29 @@ "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the name of the role", - "name": "rolename", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, {}, @@ -94086,70 +94740,54 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", - "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 user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the user lastname", - "name": "lastname", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" } ] }, @@ -94169,17 +94807,16 @@ ], "related": "", "response": [ - {}, - {}, { "description": "the secret key of the registered user", "name": "secretkey", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the api key of the registered user", @@ -94187,10 +94824,11 @@ "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" + }, + {} ] }, { @@ -94208,28 +94846,28 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ], "since": "3.0.0" }, @@ -94239,25 +94877,25 @@ "name": "updateVlanIpRange", "params": [ { - "description": "the gateway of the IPv6 network", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "ip6gateway", + "name": "forsystemvms", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "the gateway of the IPv6 network", "length": 255, - "name": "ip6cidr", + "name": "ip6gateway", "required": false, "type": "string" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "forsystemvms", + "name": "endipv6", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the gateway of the VLAN IP range", @@ -94273,6 +94911,13 @@ "required": false, "type": "string" }, + { + "description": "the beginning IP address in the VLAN IP range", + "length": 255, + "name": "startip", + "required": false, + "type": "string" + }, { "description": "the UUID of the VLAN IP range", "length": 255, @@ -94282,16 +94927,16 @@ "type": "uuid" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "startip", + "name": "startipv6", "required": false, "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "endipv6", + "name": "ip6cidr", "required": false, "type": "string" }, @@ -94301,37 +94946,36 @@ "name": "endip", "required": false, "type": "string" - }, - { - "description": "the beginning IPv6 address in the IPv6 network range", - "length": 255, - "name": "startipv6", - "required": false, - "type": "string" } ], "related": "dedicatePublicIpRange", "response": [ + { + "description": "the project name of the vlan range", + "name": "project", + "type": "string" + }, { "description": "the gateway of the VLAN IP range", "name": "gateway", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, + {}, { "description": "the start ip of the VLAN IP range", "name": "startip", @@ -94343,44 +94987,33 @@ "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" - }, - { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, - {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { @@ -94389,23 +95022,18 @@ "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", - "type": "string" - }, - { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -94414,34 +95042,44 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain name of the VLAN IP range", + "name": "domain", + "type": "string" }, - {}, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + {}, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ], @@ -94452,20 +95090,6 @@ "isasync": false, "name": "listVpnConnections", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -94483,24 +95107,25 @@ "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "id of vpc", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, @@ -94512,11 +95137,11 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -94527,91 +95152,94 @@ "type": "boolean" }, { - "description": "id of vpc", + "description": "", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "createVpnConnection", "response": [ + {}, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "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": "the project name", - "name": "project", + "description": "the owner", + "name": "account", "type": "string" }, { "description": "State of vpn connection", - "name": "state", + "name": "passive", + "type": "boolean" + }, + { + "description": "the connection ID", + "name": "id", "type": "string" }, - {}, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "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": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, - { - "description": "the owner", - "name": "account", - "type": "string" - }, { "description": "if Force NAT Encapsulation is enabled for customer gateway", "name": "forceencap", "type": "boolean" }, - {}, - { - "description": "the domain name of the owner", - "name": "domain", - "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": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -94620,38 +95248,33 @@ "type": "string" }, { - "description": "the public IP address", - "name": "publicip", - "type": "string" - }, - { - "description": "the connection ID", - "name": "id", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { @@ -94659,20 +95282,35 @@ "name": "dpd", "type": "boolean" }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, { "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", "name": "ikeversion", "type": "string" }, + { + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, { "description": "Lifetime of IKE SA of customer gateway", "name": "ikelifetime", "type": "long" + }, + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" } ] }, @@ -94681,6 +95319,13 @@ "isasync": false, "name": "listResourceLimits", "params": [ + { + "description": "Lists resource limits by ID.", + "length": 255, + "name": "id", + "required": false, + "type": "long" + }, { "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, @@ -94689,32 +95334,33 @@ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -94724,19 +95370,18 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "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": "domainid", - "related": "listDomainChildren,listDomains", + "name": "resourcetype", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Lists resource limits by ID.", + "description": "", "length": 255, - "name": "id", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -94747,41 +95392,34 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "resourcetype", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "", "response": [ - {}, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", + "name": "resourcetype", "type": "string" }, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" + "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", + "name": "resourcetypename", + "type": "string" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "the project name of the resource limit", + "name": "project", "type": "string" }, + {}, { - "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -94789,11 +95427,6 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the project id of the resource limit", - "name": "projectid", - "type": "string" - }, {}, { "description": "the account of the resource limit", @@ -94801,18 +95434,23 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the resource limit", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the resource limit", - "name": "domain", + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" + }, + { + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" }, { - "description": "the project name of the resource limit", - "name": "project", + "description": "the domain name of the resource limit", + "name": "domain", "type": "string" } ] @@ -94834,9 +95472,9 @@ "related": "createUser,enableUser,getUser", "response": [ { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" }, { "description": "the user lastname", @@ -94844,23 +95482,23 @@ "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the user name", - "name": "username", - "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", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -94868,19 +95506,15 @@ "name": "is2faenabled", "type": "boolean" }, + {}, { - "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", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -94888,30 +95522,14 @@ "name": "iscallerchilddomain", "type": "boolean" }, - {}, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { @@ -94920,14 +95538,9 @@ "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { "description": "true if user is default, false otherwise", @@ -94935,15 +95548,14 @@ "type": "boolean" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the ID of the role", - "name": "roleid", - "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", @@ -94960,11 +95572,37 @@ "name": "account", "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 ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + {} ] }, { @@ -94973,12 +95611,11 @@ "name": "removeTungstenFabricPolicy", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "policyuuid", "required": true, - "type": "uuid" + "type": "string" }, { "description": "the uuid of Tungsten-Fabric network", @@ -94988,53 +95625,54 @@ "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the ID of zone", "length": 255, - "name": "policyuuid", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listTungstenFabricPolicy,applyTungstenFabricPolicy", "response": [ - { - "description": "Tungsten-Fabric policy name", - "name": "name", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {}, { "description": "list Tungsten-Fabric policy network name", "name": "network", "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + {}, { "description": "Tungsten-Fabric tag type uuid", "name": "uuid", "type": "string" }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" + } ] }, { @@ -95050,26 +95688,19 @@ "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the zone", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "zoneid", + "related": "createZone,listZones,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" - }, - { - "description": "List by keyword", + "description": "true if this ISO is ready to be deployed", "length": 255, - "name": "keyword", + "name": "isready", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -95078,13 +95709,6 @@ "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": "true if the ISO is bootable, false otherwise", "length": 255, @@ -95093,19 +95717,12 @@ "type": "boolean" }, { - "description": "If set to true, list only unique isos across zones", - "length": 255, - "name": "showunique", - "required": false, - "since": "4.13.2", - "type": "boolean" - }, - { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "ID of the storage pool", @@ -95117,11 +95734,18 @@ "type": "uuid" }, { - "description": "true if this ISO is ready to be deployed", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isready", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" + }, + { + "description": "list all ISOs by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { "description": "show removed ISOs as well", @@ -95130,6 +95754,20 @@ "required": false, "type": "boolean" }, + { + "description": "true if the ISO is publicly available to all users, false otherwise.", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + }, + { + "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "length": 255, + "name": "isofilter", + "required": false, + "type": "string" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -95138,32 +95776,39 @@ "type": "string" }, { - "description": "flag to display the resource image for the isos", + "description": "If set to true, list only unique isos across zones", "length": 255, - "name": "showicon", + "name": "showunique", "required": false, + "since": "4.13.2", "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the ID of the zone", + "description": "flag to display the resource image for the isos", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "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" }, @@ -95177,31 +95822,24 @@ "type": "uuid" }, { - "description": "list all ISOs by name", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "name", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "true if the ISO is publicly available to all users, false otherwise.", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, - { - "description": "the hypervisor for which to restrict the search", + "description": "List by keyword", "length": 255, - "name": "hypervisor", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list ISO by ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" } @@ -95209,14 +95847,54 @@ "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "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": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { "description": "the id of userdata linked to this template", @@ -95224,72 +95902,102 @@ "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "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 project id of the template", + "name": "projectid", + "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 ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { "description": "the ID of the domain to which the template belongs", "name": "domainid", "type": "string" }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -95303,117 +96011,83 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" - }, { "description": "the userdata override policy with the userdata provided while deploying VM", "name": "userdatapolicy", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, + {}, { - "description": "the status of the template", - "name": "status", - "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 domain to which the template belongs", - "name": "domain", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the template name", - "name": "name", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { "description": "the ID of the OS type for this template.", @@ -95421,41 +96095,24 @@ "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, - {}, - {}, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { "description": "the name of the OS type for this template.", @@ -95463,75 +96120,56 @@ "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "the template ID", - "name": "id", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { "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": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" - } + {} ] }, { @@ -95540,9 +96178,9 @@ "name": "updateCloudToUseObjectStore", "params": [ { - "description": "the URL for the image store", + "description": "the name for the image store", "length": 255, - "name": "url", + "name": "name", "required": false, "type": "string" }, @@ -95554,9 +96192,9 @@ "type": "string" }, { - "description": "the name for the image store", + "description": "the URL for the image store", "length": 255, - "name": "name", + "name": "url", "required": false, "type": "string" }, @@ -95571,75 +96209,75 @@ "related": "listSwifts,addImageStoreS3,listImageStores", "response": [ { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the host's currently used disk size", "name": "disksizeused", "type": "long" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + {}, + {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "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": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { "description": "the ID of the image store", "name": "id", "type": "string" }, - {}, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "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 protocol of the image store", - "name": "protocol", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" } ], @@ -95651,50 +96289,41 @@ "name": "listAutoScalePolicies", "params": [ { - "description": "the name of the autoscale policy", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", - "type": "string" - }, - { - "description": "", + "description": "the ID of the autoscale vm group", "length": 255, - "name": "pagesize", + "name": "vmgroupid", + "related": "listAutoScaleVmGroups", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the condition of the policy", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "conditionid", - "related": "", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "action", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the name of the autoscale policy", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { "description": "the ID of the autoscale policy", @@ -95705,12 +96334,11 @@ "type": "uuid" }, { - "description": "the ID of the autoscale vm group", + "description": "List by keyword", "length": 255, - "name": "vmgroupid", - "related": "listAutoScaleVmGroups", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -95720,30 +96348,40 @@ "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "action", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the ID of the condition of the policy", "length": 255, - "name": "listall", + "name": "conditionid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", "required": false, "type": "boolean" } @@ -95751,70 +96389,70 @@ "related": "", "response": [ { - "description": "the autoscale policy ID", - "name": "id", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, { - "description": "name of the autoscale policy", - "name": "name", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, - {}, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - { - "description": "the project id autoscale policy", - "name": "projectid", - "type": "string" - }, + {}, { "description": "the cool down period for which the policy should not be evaluated after the action has been taken", "name": "quiettime", "type": "integer" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, + {}, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" + }, + { + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" } ] @@ -95834,11 +96472,6 @@ ], "related": "", "response": [ - { - "description": "id of rct", - "name": "id", - "type": "string" - }, { "description": "url", "name": "url", @@ -95851,6 +96484,11 @@ "type": "string" }, {}, + { + "description": "id of rct", + "name": "id", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -95863,13 +96501,6 @@ "isasync": true, "name": "addTungstenFabricNetworkGatewayToLogicalRouter", "params": [ - { - "description": "Tungsten-Fabric network uuid", - "length": 255, - "name": "networkuuid", - "required": true, - "type": "string" - }, { "description": "Tungsten-Fabric logical router uuid", "length": 255, @@ -95884,25 +96515,20 @@ "related": "createZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric network uuid", + "length": 255, + "name": "networkuuid", + "required": true, + "type": "string" } ], "related": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { @@ -95910,20 +96536,32 @@ "name": "uuid", "type": "string" }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, { "description": "Tungsten-Fabric logical router name", "name": "name", "type": "string" + }, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -95933,19 +96571,18 @@ "name": "updateRole", "params": [ { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", + "description": "The description of the role", "length": 255, - "name": "ispublic", + "name": "description", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "ID of the role", + "description": "creates a role with this unique name", "length": 255, - "name": "id", - "related": "importRole,listRoles,updateRole", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { "description": "The description of the role", @@ -95955,11 +96592,11 @@ "type": "string" }, { - "description": "creates a role with this unique name", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", "length": 255, - "name": "name", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", @@ -95969,41 +96606,35 @@ "type": "string" }, { - "description": "The description of the role", + "description": "ID of the role", "length": 255, - "name": "description", - "required": false, - "type": "string" + "name": "id", + "related": "importRole,listRoles,updateRole", + "required": true, + "type": "uuid" } ], "related": "importRole,listRoles", "response": [ { - "description": "the name of the role", - "name": "name", - "type": "string" - }, - { - "description": "the description of the role", - "name": "description", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", + "description": "true if role is default, false otherwise", + "name": "isdefault", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the role", + "name": "name", "type": "string" }, - {}, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the type of the role", @@ -96011,14 +96642,21 @@ "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "the description of the role", + "name": "description", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.9.0" @@ -96029,49 +96667,61 @@ "name": "listTungstenFabricNic", "params": [ { - "description": "the uuid of Tungsten-Fabric nic", + "description": "the ID of zone", "length": 255, - "name": "nicuuid", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric nic", "length": 255, - "name": "page", + "name": "nicuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", @@ -96082,18 +96732,6 @@ "name": "name", "type": "string" }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "Tungsten-Fabric nic uuid", "name": "uuid", @@ -96107,12 +96745,11 @@ "name": "listVmwareDcs", "params": [ { - "description": "Id of the CloudStack zone.", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", @@ -96129,46 +96766,47 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "Id of the CloudStack zone.", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" } ], "related": "addVmwareDc", "response": [ + {}, { - "description": "The VMware Datacenter name", - "name": "name", - "type": "string" + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "The VMware vCenter name/ip", "name": "vcenter", "type": "string" }, - { - "description": "the Zone ID associated with this VMware Datacenter", - "name": "zoneid", - "type": "long" - }, - {}, { "description": "The VMware Datacenter ID", "name": "id", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -96177,13 +96815,6 @@ "isasync": true, "name": "applyTungstenFabricPolicy", "params": [ - { - "description": "the major sequence of Tungsten-Fabric policy", - "length": 255, - "name": "majorsequence", - "required": true, - "type": "integer" - }, { "description": "the minor sequence of Tungsten-Fabric policy", "length": 255, @@ -96200,11 +96831,11 @@ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the major sequence of Tungsten-Fabric policy", "length": 255, - "name": "policyuuid", + "name": "majorsequence", "required": true, - "type": "string" + "type": "integer" }, { "description": "the uuid of network", @@ -96212,48 +96843,55 @@ "name": "networkuuid", "required": true, "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" } ], "related": "listTungstenFabricPolicy", "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Tungsten-Fabric tag type uuid", "name": "uuid", "type": "string" }, - {}, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + {}, { "description": "Tungsten-Fabric policy name", "name": "name", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "list Tungsten-Fabric policy network name", "name": "network", "type": "list" - } + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ] }, { @@ -96269,25 +96907,27 @@ "type": "boolean" }, { - "description": "", + "description": "the ID of the zone", "length": 255, - "name": "page", + "name": "id", + "related": "createZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", + "description": "List zones by resource tags (key/value pairs)", "length": 255, - "name": "available", + "name": "tags", "required": false, - "type": "boolean" + "since": "4.3", + "type": "map" }, { - "description": "flag to display the resource image for the zones", + "description": "", "length": 255, - "name": "showicon", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "the name of the zone", @@ -96297,20 +96937,12 @@ "type": "string" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "tags", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.3", - "type": "map" - }, - { - "description": "the ID of the zone", - "length": 255, - "name": "id", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" + "type": "uuid" }, { "description": "the IDs of the zones, mutually exclusive with id", @@ -96321,6 +96953,20 @@ "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" + }, { "description": "List by keyword", "length": 255, @@ -96336,41 +96982,84 @@ "type": "string" }, { - "description": "the ID of the domain associated with the zone", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "", + "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": "pagesize", + "name": "available", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "createZone,listZones", "response": [ { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" + }, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + {}, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { "description": "the Pod name", @@ -96378,18 +97067,18 @@ "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { @@ -96398,9 +97087,9 @@ "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the capacity type", + "name": "type", + "type": "short" }, { "description": "the Zone ID", @@ -96408,19 +97097,19 @@ "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { "description": "the total capacity available", @@ -96431,84 +97120,49 @@ "type": "list" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" - }, - { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, - {}, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" - }, - { - "description": "the type of the zone - core or edge", - "name": "type", - "type": "string" - }, - { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "Zone id", + "name": "id", "type": "string" }, + {}, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { @@ -96516,18 +97170,13 @@ "name": "tags", "response": [ { - "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -96541,13 +97190,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -96556,73 +97205,62 @@ "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", "type": "string" } ], "type": "set" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "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 private interfaces", + "name": "routerprivateinterfacemaxmtu", "type": "integer" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "Zone id", - "name": "id", - "type": "string" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, - {}, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "Zone Token", + "name": "zonetoken", "type": "string" - }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" } ] }, @@ -96632,11 +97270,11 @@ "name": "listRemoteAccessVpns", "params": [ { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list remote access VPNs for certain network", @@ -96648,29 +97286,13 @@ "type": "uuid" }, { - "description": "Lists remote access vpn rule with the specified ID", + "description": "public ip address id of the vpn server", "length": 255, - "name": "id", - "related": "listRemoteAccessVpns,updateRemoteAccessVpn", + "name": "publicipid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "since": "4.3", "type": "uuid" }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -96680,38 +97302,40 @@ "type": "uuid" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "pagesize", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "public ip address id of the vpn server", + "description": "", "length": 255, - "name": "publicipid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Lists remote access vpn rule with the specified ID", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "listRemoteAccessVpns,updateRemoteAccessVpn", "required": false, - "type": "boolean" + "since": "4.3", + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -96722,6 +97346,20 @@ "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "updateRemoteAccessVpn", @@ -96737,23 +97375,24 @@ "type": "integer" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, + {}, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { @@ -96762,30 +97401,28 @@ "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, - {}, - {}, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -96794,10 +97431,11 @@ "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" - } + }, + {} ] }, { @@ -96805,13 +97443,6 @@ "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": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", "length": 255, @@ -96826,28 +97457,32 @@ "related": "listQuarantinedIps,updateQuarantinedIp,removeQuarantinedIp", "required": false, "type": "uuid" + }, + { + "description": "The reason for removing the public IP address from quarantine prematurely.", + "length": 255, + "name": "removalreason", + "required": true, + "type": "string" } ], "related": "listQuarantinedIps,updateQuarantinedIp", "response": [ { - "description": "ID of the quarantine process.", - "name": "id", + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", "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 current status of the latest 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 reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, { @@ -96856,35 +97491,38 @@ "type": "date" }, { - "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": "The public IP address in quarantine.", - "name": "ipaddress", + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "When the quarantine was created.", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, - {}, { - "description": "When the quarantine was created.", - "name": "created", + "description": "When the quarantine was removed.", + "name": "removed", "type": "date" } ], @@ -96905,6 +97543,12 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, {}, { "description": "true if operation is executed successfully", @@ -96920,13 +97564,7 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} + } ] }, { @@ -96944,27 +97582,27 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -96973,6 +97611,14 @@ "isasync": true, "name": "createServiceInstance", "params": [ + { + "description": "The right (outside) network ID for the service instance", + "length": 255, + "name": "rightnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, { "description": "The name of the service instance", "length": 255, @@ -96996,6 +97642,21 @@ "required": false, "type": "uuid" }, + { + "description": "The template ID that specifies the image for the service appliance", + "length": 255, + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + }, + { + "description": "An optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "The service offering ID that defines the resources consumed by the service appliance", "length": 255, @@ -97019,85 +97680,62 @@ "related": "activateProject,suspendProject", "required": false, "type": "uuid" - }, - { - "description": "The right (outside) network ID for the service instance", - "length": 255, - "name": "rightnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - }, - { - "description": "An optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "The template ID that specifies the image for the service appliance", - "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" } ], "related": "", "response": [ { - "description": "the name of the virtual machine", - "name": "name", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, + {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the 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 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" - }, - {} + } ] }, { @@ -97115,28 +97753,28 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} + } ] }, { @@ -97144,13 +97782,6 @@ "isasync": false, "name": "listNetscalerLoadBalancerNetworks", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -97172,88 +97803,137 @@ "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter", "required": true, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", "type": "integer" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "the name of the network", - "name": "name", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "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 network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { @@ -97262,419 +97942,377 @@ "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the name of the network", + "name": "name", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", "type": "integer" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the owner of the network", - "name": "account", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the project name of the address", + "name": "project", "type": "string" }, + {}, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 type of the network", - "name": "type", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "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 physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the 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 Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, - {}, { - "description": "the network's gateway", - "name": "gateway", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the list of resource tags associated with network", - "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "list" + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, - {}, { - "description": "the domain name of the network owner", - "name": "domain", - "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": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "the id of the network", - "name": "id", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "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": "the traffic type of the network", - "name": "traffictype", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" + "description": "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": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" + } + ], + "type": "list" } ] }, @@ -97693,12 +98331,17 @@ } ], "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", @@ -97709,12 +98352,7 @@ "name": "success", "type": "boolean" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -97733,127 +98371,127 @@ ], "related": "migrateSystemVm", "response": [ - {}, { - "description": "the systemvm agent version", - "name": "version", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, - {}, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, + {}, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, + {}, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "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", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, { "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", @@ -97861,88 +98499,88 @@ "type": "integer" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "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 template name for the system VM", + "name": "templatename", + "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "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 second DNS for the system VM", - "name": "dns2", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -97953,11 +98591,11 @@ "name": "listNetworkIsolationMethods", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -97967,11 +98605,11 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", @@ -97982,7 +98620,6 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "Network isolation method name", "name": "name", @@ -97992,106 +98629,149 @@ "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. ", + "description": "Lists host HA resources", "isasync": false, - "name": "registerVnfTemplate", + "name": "listHostHAResources", "params": [ { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "description": "List by host ID", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": false, + "type": "uuid" + } + ], + "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", + "response": [ + { + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the name of the template", - "length": 255, - "name": "name", - "required": true, + "description": "operation status", + "name": "status", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, + {}, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "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" + } + ], + "since": "4.11" + }, + { + "description": "Registers an existing VNF template into the CloudStack cloud. ", + "isasync": false, + "name": "registerVnfTemplate", + "params": [ + { + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "isdynamicallyscalable", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "isfeatured", + "name": "templatetype", + "required": false, + "since": "4.19.0", + "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 target hypervisor for the template", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, - "name": "hypervisor", + "name": "format", "required": true, "type": "string" }, { - "description": "Register template for the project", + "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": "projectid", - "related": "activateProject,suspendProject", + "name": "vnfdetails", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "isextractable", + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "the tag for this template.", + "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": "templatetag", + "name": "vnfnics", "required": false, - "type": "string" + "type": "map" }, { - "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "vnfdetails", + "name": "isextractable", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "vnfnics", + "name": "details", "required": false, "type": "map" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "deployasis", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "true if this template requires HVM", + "length": 255, + "name": "requireshvm", "required": false, - "since": "4.15.1", "type": "boolean" }, { @@ -98103,32 +98783,34 @@ "type": "list" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "bits", + "name": "directdownload", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "true if this template requires HVM", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "requireshvm", + "name": "bits", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "Register template for the project", "length": 255, - "name": "account", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if the template supports the password reset feature; default is false", + "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": "passwordenabled", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "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.", @@ -98138,117 +98820,206 @@ "type": "string" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "the target hypervisor for the template", "length": 255, - "name": "templatetype", + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "sshkeyenabled", + "name": "deployasis", "required": false, + "since": "4.15.1", "type": "boolean" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "ispublic", + "name": "isrouting", "required": false, "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "sshkeyenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "ostypeid", - "related": "", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "isrouting", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "directdownload", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "the ID of the zone the template is to be hosted on", + "description": "the tag for this template.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "templatetag", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "description": "the name of the template", "length": 255, - "name": "format", + "name": "name", "required": true, "type": "string" } ], "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ + { + "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 name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the 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 template name", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, { "description": "the physical size of the template", "name": "physicalsize", "type": "long" }, + {}, + {}, { "description": "true if template is sshkey enabled, false otherwise", "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "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": "userdataparams", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -98257,13 +99028,13 @@ "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -98272,298 +99043,271 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, { "description": "Lists the download progress of a template across all secondary storages", "name": "downloaddetails", "type": "list" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "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": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, { "description": "if root disk template, then ids of the datas disk templates this template owns", "name": "childtemplates", "type": "set" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "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 userdata linked to this template", "name": "userdataid", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "the name of the secondary storage host for the template", "name": "hostname", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" - }, - {}, - { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, + "description": "the size of the template", + "name": "size", + "type": "long" + } + ], + "since": "4.19.0" + }, + { + "description": "Lists VM stats", + "isasync": false, + "name": "listVirtualMachinesUsageHistory", + "params": [ { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "the ID of the virtual machine.", + "length": 255, + "name": "id", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "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 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 IDs of the virtual machines, mutually exclusive with id.", + "length": 255, + "name": "ids", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": false, + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the template display text", - "name": "displaytext", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" - }, - {}, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the template name", - "name": "name", - "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Lists host HA resources", - "isasync": false, - "name": "listHostHAResources", - "params": [ - { - "description": "List by host ID", + "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": "hostid", - "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "name", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", + "related": "listSystemVmsUsageHistory", "response": [ { - "description": "the ID of the host", - "name": "hostid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -98571,44 +99315,25 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, {}, + {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" - }, - { - "description": "operation status", - "name": "status", - "type": "boolean" - }, - {} + "description": "the list of VM stats", + "name": "stats", + "type": "list" + } ], - "since": "4.11" + "since": "4.17" }, { - "description": "Lists VM stats", + "description": "list Tungsten-Fabric firewall policy", "isasync": false, - "name": "listVirtualMachinesUsageHistory", + "name": "listTungstenFabricFirewallPolicy", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, { "description": "", "length": 255, @@ -98616,86 +99341,13 @@ "required": false, "type": "integer" }, - { - "description": "the ID of the virtual machine.", - "length": 255, - "name": "id", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" - }, - { - "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the IDs of the virtual machines, mutually exclusive with id.", - "length": 255, - "name": "ids", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "list" - }, - { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, { "description": "List by keyword", "length": 255, "name": "keyword", "required": false, "type": "string" - } - ], - "related": "listSystemVmsUsageHistory", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the list of VM stats", - "name": "stats", - "type": "list" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" }, - {}, - {} - ], - "since": "4.17" - }, - { - "description": "list Tungsten-Fabric firewall policy", - "isasync": false, - "name": "listTungstenFabricFirewallPolicy", - "params": [ { "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, @@ -98703,13 +99355,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, @@ -98717,57 +99362,34 @@ "required": false, "type": "string" }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric firewall policy uuid", + "name": "uuid", "type": "string" }, - { - "description": "list Tungsten-Fabric firewall rule", - "name": "firewallrule", - "type": "list" - }, { "description": "Tungsten-Fabric firewall policy name", "name": "name", "type": "string" }, - { - "description": "Tungsten-Fabric firewall policy uuid", - "name": "uuid", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", @@ -98778,6 +99400,22 @@ "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" } ] }, @@ -98790,48 +99428,58 @@ "description": "host ID", "length": 255, "name": "id", - "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } ], - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "response": [ - {}, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, + {}, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the Zone name of the host", + "name": "zonename", "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 host hypervisor", @@ -98839,33 +99487,48 @@ "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "capabilities of the host", + "name": "capabilities", + "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 IP address of the host", - "name": "ipaddress", + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "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": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { @@ -98874,101 +99537,182 @@ "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, { "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", "name": "memorytotal", "type": "long" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { "description": "the outgoing network traffic on the host", "name": "networkkbswrite", "type": "long" }, + { + "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 amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" + }, { "description": "the number of CPU sockets on the host", "name": "cpusockets", "type": "integer" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "the Pod name of the host", + "name": "podname", + "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 amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { "description": "the date and time the host was last pinged", "name": "lastpinged", "type": "date" }, + {}, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, { "description": "GPU cards present in the host", "name": "gpugroup", "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, { "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { @@ -98977,23 +99721,18 @@ "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", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { @@ -99002,171 +99741,70 @@ "type": "string" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" - }, - {}, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" - }, - { - "description": "the host version", - "name": "version", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, { "description": "the amount of the host's CPU currently allocated in MHz", "name": "cpuallocatedvalue", "type": "long" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" } ], "since": "4.16.0.0" @@ -99177,16 +99815,9 @@ "name": "createKubernetesCluster", "params": [ { - "description": "URL for the docker image private registry", - "length": 255, - "name": "dockerregistryurl", - "required": false, - "type": "string" - }, - { - "description": "password for the docker image private registry", + "description": "user name for the docker image private registry", "length": 255, - "name": "dockerregistrypassword", + "name": "dockerregistryusername", "required": false, "type": "string" }, @@ -99199,11 +99830,12 @@ "type": "uuid" }, { - "description": "number of Kubernetes cluster worker nodes", + "description": "Kubernetes version with which cluster to be launched", "length": 255, - "name": "size", + "name": "kubernetesversionid", + "related": "listKubernetesSupportedVersions", "required": false, - "type": "long" + "type": "uuid" }, { "description": "name for the Kubernetes cluster", @@ -99213,56 +99845,48 @@ "type": "string" }, { - "description": "description for the Kubernetes cluster", + "description": "URL for the docker image private registry", "length": 255, - "name": "description", + "name": "dockerregistryurl", "required": false, "type": "string" }, { - "description": "Deploy cluster for the project", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, "type": "uuid" }, { - "description": "availability zone in which Kubernetes cluster to be launched", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "Network in which Kubernetes cluster is to be launched", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "root disk size in GB for each node", + "description": "description for the Kubernetes cluster", "length": 255, - "name": "noderootdisksize", + "name": "description", "required": false, - "type": "long" + "type": "string" }, { - "description": "user name for the docker image private registry", + "description": "Deploy cluster for the project", "length": 255, - "name": "dockerregistryusername", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "number of Kubernetes cluster control nodes, default is 1", + "description": "password for the docker image private registry", "length": 255, - "name": "controlnodes", + "name": "dockerregistrypassword", "required": false, - "type": "long" + "type": "string" }, { "description": "type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.", @@ -99273,11 +99897,11 @@ "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", "length": 255, - "name": "account", + "name": "masternodes", "required": false, - "type": "string" + "type": "long" }, { "description": "name of the ssh key pair used to login to the virtual machines", @@ -99287,17 +99911,25 @@ "type": "string" }, { - "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", + "description": "root disk size in GB for each node", "length": 255, - "name": "masternodes", + "name": "noderootdisksize", "required": false, "type": "long" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "availability zone in which Kubernetes cluster to be launched", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Network in which Kubernetes cluster is to be launched", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, @@ -99309,20 +99941,26 @@ "type": "string" }, { - "description": "Kubernetes version with which cluster to be launched", + "description": "number of Kubernetes cluster control nodes, default is 1", "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "controlnodes", "required": false, - "type": "uuid" + "type": "long" + }, + { + "description": "number of Kubernetes cluster worker nodes", + "length": 255, + "name": "size", + "required": false, + "type": "long" } ], "related": "startKubernetesCluster", "response": [ { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { "description": "the control nodes count for the Kubernetes cluster", @@ -99330,96 +99968,86 @@ "type": "long" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" - }, - { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" - }, - { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, + {}, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "keypair details", + "name": "keypair", "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 date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, - {}, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { "description": "Maximum size of the cluster", @@ -99427,53 +100055,48 @@ "type": "long" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" - }, - { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { @@ -99482,13 +100105,18 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", "type": "boolean" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { @@ -99497,13 +100125,23 @@ "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" } ] @@ -99523,15 +100161,15 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", + "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "required": false, "type": "uuid" }, @@ -99544,47 +100182,42 @@ "type": "uuid" }, { - "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", + "description": "", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createStorageNetworkIpRange", "response": [ { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", - "type": "string" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, {}, { - "description": "the gateway of the storage network IP range", - "name": "gateway", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, { @@ -99593,31 +100226,36 @@ "type": "string" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the uuid of storage network IP range.", + "name": "id", + "type": "string" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "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", + "type": "string" }, { "description": "the start ip of the storage network IP range", "name": "startip", "type": "string" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "3.0.0" }, @@ -99644,40 +100282,45 @@ ], "related": "listVirtualRouterElements", "response": [ + {}, + { + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" + }, { "description": "Enabled/Disabled the service provider", "name": "enabled", "type": "boolean" }, - {}, { - "description": "the domain associated with the provider", - "name": "domain", + "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 account associated with the provider", + "name": "account", + "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the id of the router", + "name": "id", "type": "string" }, { @@ -99686,16 +100329,11 @@ "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - } + {} ] }, { @@ -99703,13 +100341,6 @@ "isasync": true, "name": "deleteDomain", "params": [ - { - "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" - }, { "description": "ID of domain to delete", "length": 255, @@ -99717,31 +100348,38 @@ "related": "listDomainChildren,listDomains", "required": true, "type": "uuid" + }, + { + "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, + "type": "boolean" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -99753,49 +100391,49 @@ "description": "ID of the host", "length": 255, "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } ], "related": "configureHAForHost,disableHAForHost,listHostHAProviders", "response": [ + { + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, { "description": "the HA state of the host", "name": "hastate", "type": "hastate" }, + {}, { "description": "operation status", "name": "status", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the ID of the host", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the host HA provider", "name": "haprovider", "type": "string" }, - {}, - { - "description": "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.11" @@ -99805,14 +100443,6 @@ "isasync": true, "name": "migrateVolume", "params": [ - { - "description": "destination storage pool ID to migrate the volume to", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": true, - "type": "uuid" - }, { "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.", "length": 255, @@ -99829,6 +100459,14 @@ "required": true, "type": "uuid" }, + { + "description": "destination storage pool ID to migrate the volume to", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": true, + "type": "uuid" + }, { "description": "if the volume should be live migrated when it is attached to a running vm", "length": 255, @@ -99840,281 +100478,210 @@ "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "name of the disk volume", - "name": "name", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "the status of the volume", - "name": "status", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, + {}, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "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": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, + {}, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { @@ -100123,24 +100690,23 @@ "type": "integer" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, - {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -100149,89 +100715,161 @@ "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "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" } ], "since": "3.0.0" @@ -100259,22 +100897,6 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric application policy uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", - "type": "list" - }, - {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", @@ -100285,6 +100907,12 @@ "name": "zoneid", "type": "long" }, + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" + }, + {}, {}, { "description": "list Tungsten-Fabric tag", @@ -100292,14 +100920,24 @@ "type": "list" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -100309,48 +100947,49 @@ "name": "listEvents", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the type of the resource associated with the event", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "resourcetype", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.17.0", - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the event type (see event types)", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" }, { - "description": "the time the event was entered", + "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": "entrytime", + "name": "startid", + "related": "listEvents", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the event level (INFO, WARN, ERROR)", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "level", + "name": "projectid", + "related": "activateProject,suspendProject", "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": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "the ID of the resource associated with the event", @@ -100361,120 +101000,119 @@ "type": "string" }, { - "description": "the ID of the event", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "listEvents", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the duration of the event", + "description": "the event level (INFO, WARN, ERROR)", "length": 255, - "name": "duration", + "name": "level", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "startdate", + "name": "account", "required": false, - "type": "date" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "the event type (see event types)", + "description": "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": "type", + "name": "enddate", "required": false, - "type": "string" + "type": "date" }, { - "description": "", + "description": "the ID of the event", "length": 255, - "name": "page", + "name": "id", + "related": "listEvents", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the duration of the event", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "duration", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "true to list archived events otherwise false", + "description": "the time the event was entered", "length": 255, - "name": "archived", + "name": "entrytime", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "integer" }, { - "description": "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event", + "description": "List by keyword", "length": 255, - "name": "startid", - "related": "listEvents", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "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": "account", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { - "description": "", + "description": "the type of the resource associated with the event", "length": 255, - "name": "pagesize", + "name": "resourcetype", "required": false, - "type": "integer" + "since": "4.17.0", + "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\")", + "description": "true to list archived events otherwise false", "length": 255, - "name": "enddate", + "name": "archived", "required": false, - "type": "date" + "since": "4.19.0", + "type": "boolean" } ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the resource", + "name": "resourcetype", "type": "string" }, + {}, { - "description": "the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)", - "name": "account", + "description": "the type of the event (see event types)", + "name": "type", "type": "string" }, { - "description": "the id of the resource", - "name": "resourceid", + "description": "the event level (INFO, WARN, ERROR)", + "name": "level", "type": "string" }, { - "description": "a brief description of the event", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the account's domain", - "name": "domain", + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -100483,10 +101121,15 @@ "type": "state" }, { - "description": "the type of the event (see event types)", - "name": "type", + "description": "the ID of the event", + "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 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", @@ -100498,29 +101141,28 @@ "type": "string" }, { - "description": "whether the event is parented", - "name": "parentid", + "description": "the id of the account's domain", + "name": "domainid", "type": "string" }, { - "description": "the ID of the event", - "name": "id", + "description": "whether the event is parented", + "name": "parentid", "type": "string" }, - {}, { - "description": "the type of the resource", - "name": "resourcetype", + "description": "the name of the account's domain", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date the event was created", + "name": "created", + "type": "date" }, { - "description": "the event level (INFO, WARN, ERROR)", - "name": "level", + "description": "a brief description of the event", + "name": "description", "type": "string" }, { @@ -100528,25 +101170,21 @@ "name": "resourcename", "type": "string" }, + {}, { - "description": "the date the event was created", - "name": "created", - "type": "date" - }, - { - "description": "whether the event has been archived or not", - "name": "archived", - "type": "boolean" + "description": "the id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)", + "name": "account", "type": "string" }, { - "description": "the id of the account's domain", - "name": "domainid", - "type": "string" + "description": "whether the event has been archived or not", + "name": "archived", + "type": "boolean" } ] }, @@ -100556,12 +101194,12 @@ "name": "updateVMAffinityGroup", "params": [ { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "description": "The ID of the virtual machine", "length": 255, - "name": "affinitygroupnames", - "related": "", - "required": false, - "type": "list" + "name": "id", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { "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", @@ -100572,109 +101210,207 @@ "type": "list" }, { - "description": "The ID of the virtual machine", + "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": "id", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" } ], "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "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 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 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": "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" + } + ], + "type": "set" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, { "description": "the project name of the vm", "name": "project", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "name": "publicip", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, + {}, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the 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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -100688,57 +101424,175 @@ "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "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": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the project id of the group", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the 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 ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + {}, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "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" }, { @@ -100746,47 +101600,42 @@ "name": "ingressrule", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -100800,28 +101649,38 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" } ], "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", @@ -100833,103 +101692,93 @@ "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", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], "type": "set" }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "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" }, { @@ -100937,9 +101786,14 @@ "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the protocol of the security group rule", @@ -100947,18 +101801,18 @@ "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -100966,8 +101820,8 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -100976,23 +101830,23 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the 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": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -101006,8 +101860,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -101018,24 +101872,19 @@ ], "type": "set" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], @@ -101047,392 +101896,145 @@ "type": "integer" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { "description": "the account owning the security group", "name": "account", "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" } ], "type": "set" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, { "description": "the user's name who deployed the virtual machine", "name": "username", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "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": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the 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 name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "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 ID of the nic", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - {}, - {}, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the type of the nic", + "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", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - {}, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ { "description": "the name of the corresponding network", "name": "networkname", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { @@ -101441,9 +102043,9 @@ "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 isolated private VLAN type if available", @@ -101451,23 +102053,18 @@ "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -101475,143 +102072,184 @@ "name": "nsxlogicalswitchport", "type": "string" }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, { "description": "true if nic is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { "description": "the netmask of the nic", "name": "netmask", "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" } ], "type": "set" }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, { "description": "the outgoing network traffic on the host in KiB", "name": "networkkbswrite", "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { "description": "OS name of the vm", "name": "osdisplayname", "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" } ] }, @@ -101631,8 +102269,18 @@ "related": "configureHAForHost,disableHAForHost", "response": [ { - "description": "if host HA is enabled for the host", - "name": "haenable", + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "operation status", + "name": "status", "type": "boolean" }, { @@ -101641,31 +102289,21 @@ "type": "integer" }, { - "description": "operation status", - "name": "status", + "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 HA state of the host", + "name": "hastate", + "type": "hastate" }, {}, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, { "description": "the host HA provider", "name": "haprovider", "type": "string" }, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, {} ], "since": "4.11" @@ -101692,22 +102330,12 @@ ], "related": "listRegisteredServicePackages", "response": [ - { - "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": "Description of Service Package", "name": "description", @@ -101718,113 +102346,157 @@ "name": "name", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "Service Package UUID", + "name": "id", + "type": "string" + } ] }, { - "description": "Creates resource tag(s)", - "isasync": true, - "name": "createTags", + "description": "Add +-credits to an account", + "isasync": false, + "name": "quotaCredits", "params": [ { - "description": "list of resources to create the tags for", + "description": "Minimum balance threshold of the account", "length": 255, - "name": "resourceids", + "name": "min_balance", + "required": false, + "type": "double" + }, + { + "description": "Domain for which quota credits need to be added", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": true, - "type": "list" + "type": "uuid" }, { - "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", + "description": "Account for which quota enforce is set to false will not be locked when there is no credit balance", "length": 255, - "name": "customer", + "name": "quota_enforce", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Map of tags (key/value pairs)", + "description": "Account Id for which quota credits need to be added", "length": 255, - "name": "tags", + "name": "account", "required": true, - "type": "map" + "type": "string" }, { - "description": "type of the resource", + "description": "Value of the credits to be added+, subtracted-", "length": 255, - "name": "resourcetype", + "name": "value", "required": true, - "type": "string" + "type": "double" } ], + "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user name of the admin who updated the credits", + "name": "updated_by", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the credit deposited", + "name": "credits", + "type": "bigdecimal" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "currency", + "name": "currency", + "type": "string" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account name of the admin who updated the credits", + "name": "updated_on", + "type": "date" + }, + {} ], - "since": "4.0.0" + "since": "4.7.0" }, { - "description": "Lists the CA public certificate(s) as support by the configured/provided CA plugin", - "isasync": false, - "name": "listCaCertificate", + "description": "Creates resource tag(s)", + "isasync": true, + "name": "createTags", "params": [ { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "description": "list of resources to create the tags for", "length": 255, - "name": "provider", + "name": "resourceids", + "required": true, + "type": "list" + }, + { + "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", + "length": 255, + "name": "customer", "required": false, "type": "string" + }, + { + "description": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" + }, + { + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": true, + "type": "map" } ], - "related": "", "response": [ {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "The CA certificate(s)", - "name": "cacertificates", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "Private key for the certificate", - "name": "privatekey", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The client certificate", - "name": "certificate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], - "since": "4.11.0" + "since": "4.0.0" }, { "description": "Create an Internal Load Balancer element.", @@ -101847,31 +102519,76 @@ "name": "id", "type": "string" }, - { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" - }, - {}, { "description": "the physical network service provider id of the element", "name": "nspid", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.2.0" }, + { + "description": "Lists the CA public certificate(s) as support by the configured/provided CA plugin", + "isasync": false, + "name": "listCaCertificate", + "params": [ + { + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "The client certificate", + "name": "certificate", + "type": "string" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Private key for the certificate", + "name": "privatekey", + "type": "string" + }, + { + "description": "The CA certificate(s)", + "name": "cacertificates", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.11.0" + }, { "description": "Reset api count", "isasync": false, @@ -101888,6 +102605,11 @@ ], "response": [ {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -101899,11 +102621,6 @@ "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", @@ -101926,10 +102643,11 @@ } ], "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" }, {}, { @@ -101938,11 +102656,10 @@ "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", @@ -101956,55 +102673,55 @@ "name": "provisionTemplateDirectDownloadCertificate", "params": [ { - "description": "the id of the direct download certificate to provision", + "description": "the host to provision the certificate", "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate", + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, "type": "uuid" }, { - "description": "the host to provision the certificate", + "description": "the id of the direct download certificate to provision", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "id", + "related": "uploadTemplateDirectDownloadCertificate", "required": true, "type": "uuid" } ], "related": "", "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "indicates if the certificate has been revoked from the host, failed or skipped", "name": "status", "type": "string" }, { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "the name of the host", + "name": "hostname", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "indicates the details in case of failure or host skipped", + "name": "details", "type": "string" }, { "description": "the 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": "4.17.0" @@ -102028,13 +102745,6 @@ "required": true, "type": "string" }, - { - "description": "Type of the alert", - "length": 255, - "name": "type", - "required": true, - "type": "short" - }, { "description": "Zone id for which alert is generated", "length": 255, @@ -102043,6 +102753,13 @@ "required": false, "type": "uuid" }, + { + "description": "Type of the alert", + "length": 255, + "name": "type", + "required": true, + "type": "short" + }, { "description": "Pod id for which alert is generated", "length": 255, @@ -102058,22 +102775,22 @@ "name": "success", "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "4.3" @@ -102083,13 +102800,6 @@ "isasync": false, "name": "updateProjectRole", "params": [ - { - "description": "creates a project role with this unique name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "ID of project where role is being created", "length": 255, @@ -102099,12 +102809,11 @@ "type": "uuid" }, { - "description": "ID of the Project role", + "description": "creates a project role with this unique name", "length": 255, - "name": "id", - "related": "updateProjectRole", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { "description": "The description of the Project role", @@ -102112,47 +102821,55 @@ "name": "description", "required": false, "type": "string" + }, + { + "description": "ID of the Project role", + "length": 255, + "name": "id", + "related": "updateProjectRole", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the name of the role", - "name": "name", - "type": "string" - }, - { - "description": "the id of the project", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", "name": "ispublic", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the role", + "name": "id", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "the description of the role", + "name": "description", "type": "string" }, - {}, { - "description": "the description of the role", - "name": "description", + "description": "the name of the role", + "name": "name", "type": "string" - } + }, + { + "description": "the id of the project", + "name": "projectid", + "type": "string" + }, + {} ], "since": "4.15.0" }, @@ -102161,13 +102878,6 @@ "isasync": false, "name": "addLdapConfiguration", "params": [ - { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" - }, { "description": "linked domain", "length": 255, @@ -102182,15 +102892,21 @@ "name": "port", "required": true, "type": "integer" + }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "name of the host running the ldap server", @@ -102203,15 +102919,16 @@ "type": "string" }, {}, + { + "description": "port the ldap server is running on", + "name": "port", + "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" } ], "since": "4.2.0" @@ -102222,9 +102939,9 @@ "name": "ldapConfig", "params": [ { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", "length": 255, - "name": "queryfilter", + "name": "hostname", "required": false, "type": "string" }, @@ -102236,11 +102953,18 @@ "type": "string" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", + "description": "Enter the password.", "length": 255, - "name": "ssl", + "name": "bindpass", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "Specify the LDAP port if required, default is 389.", + "length": 255, + "name": "port", + "required": false, + "type": "integer" }, { "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", @@ -102257,52 +102981,44 @@ "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", "length": 255, - "name": "hostname", + "name": "queryfilter", "required": false, "type": "string" }, { - "description": "If true return current LDAP configuration", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "Enter the password.", + "description": "Enter the path to trust certificates store.", "length": 255, - "name": "bindpass", + "name": "truststore", "required": false, "type": "string" }, { - "description": "Specify the LDAP port if required, default is 389.", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", "length": 255, - "name": "port", + "name": "ssl", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "Enter the path to trust certificates store.", + "description": "If true return current LDAP configuration", "length": 255, - "name": "truststore", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" } ], "related": "ldapRemove", "response": [ - {}, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" }, { @@ -102310,12 +103026,12 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "DN password", + "name": "bindpass", "type": "string" }, + {}, { "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", "name": "searchbase", @@ -102327,20 +103043,21 @@ "type": "string" }, { - "description": "DN password", - "name": "bindpass", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, { "description": "Specify the distinguished name of a user with the search permission on the directory", "name": "binddn", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -102360,20 +103077,9 @@ ], "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 Zone", - "name": "zoneid", + "description": "the description of the Storage Policy", + "name": "description", "type": "string" }, { @@ -102381,20 +103087,31 @@ "name": "policyid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the ID of the Storage Policy", "name": "id", "type": "string" }, {}, + {}, { "description": "the name of the Storage Policy", "name": "name", "type": "string" }, { - "description": "the description of the Storage Policy", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" } ] @@ -102416,14 +103133,14 @@ "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", @@ -102432,9 +103149,9 @@ }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -102443,6 +103160,13 @@ "isasync": true, "name": "migrateVPC", "params": [ + { + "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", + "length": 255, + "name": "tiernetworkofferings", + "required": false, + "type": "map" + }, { "description": "the ID of the vpc", "length": 255, @@ -102451,13 +103175,6 @@ "required": true, "type": "uuid" }, - { - "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", - "length": 255, - "name": "tiernetworkofferings", - "required": false, - "type": "map" - }, { "description": "vpc offering ID", "length": 255, @@ -102477,36 +103194,19 @@ "related": "createVPC,listVPCs,updateVPC", "response": [ { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "the project id of the VPC", - "name": "projectid", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the owner of the VPC", - "name": "account", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, - {}, - {}, { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "true VPC requires restart", @@ -102514,71 +103214,9 @@ "type": "boolean" }, { - "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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { "description": "the list of networks belongign to the VPC", @@ -102586,90 +103224,66 @@ "type": "list" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, { "description": "the project name of the VPC", "name": "project", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - }, - { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "the domain name of the owner", - "name": "domain", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", "type": "integer" }, { - "description": "the id of the VPC", - "name": "id", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, + {}, { "description": "the list of supported services", "name": "service", @@ -102683,16 +103297,16 @@ "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 name", + "name": "name", + "type": "string" + }, { "description": "the capability value", "name": "value", @@ -102706,24 +103320,24 @@ "name": "provider", "response": [ { - "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", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "state of the network provider", + "name": "state", + "type": "string" }, { "description": "the provider name", @@ -102731,14 +103345,14 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" @@ -102747,18 +103361,116 @@ "type": "list" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the project", + "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 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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, + { + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "the id of the VPC", + "name": "id", "type": "string" }, { @@ -102767,9 +103479,14 @@ "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "created", + "type": "date" } ], "since": "4.11.0" @@ -102790,9 +103507,9 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -102800,16 +103517,16 @@ "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" }, - {}, {} ] }, @@ -102819,31 +103536,36 @@ "name": "updateAnnotationVisibility", "params": [ { - "description": "the annotation is visible for admins only", + "description": "the id of the annotation", "length": 255, - "name": "adminsonly", + "name": "id", "required": true, - "type": "boolean" + "type": "string" }, { - "description": "the id of the annotation", + "description": "the annotation is visible for admins only", "length": 255, - "name": "id", + "name": "adminsonly", "required": true, - "type": "string" + "type": "boolean" } ], "related": "removeAnnotation", "response": [ + { + "description": "the (uu)id of the annotation", + "name": "id", + "type": "string" + }, { "description": "The username of the user that entered the annotation", "name": "username", "type": "string" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" }, { "description": "the contents of the annotation", @@ -102851,51 +103573,46 @@ "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" + }, + { + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, + {}, { "description": "the creation timestamp for this annotation", "name": "created", "type": "date" }, + {}, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the name of the entity to which this annotation pertains", "name": "entityname", "type": "string" - }, - { - "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" } ], "since": "4.16" @@ -102937,29 +103654,25 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric address group uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric address group ip prefix length", - "name": "ipprefixlen", - "type": "int" + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", "type": "string" }, { @@ -102967,18 +103680,22 @@ "name": "name", "type": "string" }, + {}, { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", - "type": "string" + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" }, - {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -102994,12 +103711,11 @@ "type": "integer" }, { - "description": "the Physical Network ID", + "description": "List by keyword", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "bigswitch BCF controller device ID", @@ -103010,73 +103726,74 @@ "type": "uuid" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "pagesize", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "NAT support", - "name": "nat", - "type": "boolean" - }, - {}, - { - "description": "the controller Ip address", - "name": "hostname", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" }, { - "description": "the controller password", - "name": "password", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "NAT support", + "name": "nat", + "type": "boolean" }, + {}, + {}, { "description": "device id of the BigSwitch BCF Controller", "name": "bcfdeviceid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "device name", - "name": "bigswitchdevicename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the controller username", "name": "username", "type": "string" + }, + { + "description": "the controller password", + "name": "password", + "type": "string" } ], "since": "4.6.0" @@ -103087,19 +103804,28 @@ "name": "updateConfiguration", "params": [ { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", + "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "imagestoreuuid", + "related": "listSwifts,addImageStoreS3,listImageStores", "required": false, "type": "uuid" }, { - "description": "the value of the configuration", - "length": 4096, - "name": "value", + "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": "string" + "type": "uuid" + }, + { + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "type": "uuid" }, { "description": "the ID of the Zone to update the parameter value for corresponding zone", @@ -103110,10 +103836,10 @@ "type": "uuid" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, @@ -103125,42 +103851,32 @@ "required": false, "type": "uuid" }, + { + "description": "the value of the configuration", + "length": 4096, + "name": "value", + "required": false, + "type": "string" + }, { "description": "the name of the configuration", "length": 255, "name": "name", "required": true, "type": "string" - }, - { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", - "length": 255, - "name": "imagestoreuuid", - "related": "listSwifts,addImageStoreS3,listImageStores", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the Account to update the parameter value for corresponding account", - "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" } ], "related": "", "response": [ { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the configuration", + "name": "name", + "type": "string" }, { "description": "the component of the configuration", @@ -103168,18 +103884,8 @@ "type": "string" }, { - "description": "the value of the configuration", - "name": "id", - "type": "long" - }, - { - "description": "the description of the configuration", - "name": "description", - "type": "string" - }, - { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { @@ -103189,18 +103895,13 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the value of the configuration", + "name": "id", + "type": "long" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { @@ -103209,28 +103910,44 @@ "type": "string" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of the configuration value", + "name": "type", "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "the description of the configuration", + "name": "description", "type": "string" }, { - "description": "the name of the configuration", - "name": "name", + "description": "the subgroup of the configuration", + "name": "subgroup", + "type": "string" + }, + { + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" + }, + { + "description": "the value of the configuration", + "name": "value", "type": "string" }, { @@ -103246,43 +103963,33 @@ "name": "configureHAForHost", "params": [ { - "description": "ID of the host", + "description": "HA provider", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "provider", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "HA provider", + "description": "ID of the host", "length": 255, - "name": "provider", + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, - "type": "string" + "type": "uuid" } ], "related": "disableHAForHost", "response": [ { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the host", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, {}, { - "description": "operation status", - "name": "status", - "type": "boolean" - }, - { - "description": "the host HA provider", - "name": "haprovider", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { @@ -103296,9 +104003,19 @@ "type": "hastate" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host HA provider", + "name": "haprovider", "type": "string" + }, + { + "description": "operation status", + "name": "status", + "type": "boolean" + }, + { + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" } ], "since": "4.11" @@ -103309,12 +104026,11 @@ "name": "listVolumesUsageHistory", "params": [ { - "description": "the ID of the volume.", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "id", - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "enddate", "required": false, - "type": "uuid" + "type": "date" }, { "description": "", @@ -103323,13 +104039,6 @@ "required": false, "type": "integer" }, - { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, { "description": "the IDs of the volumes, mutually exclusive with id.", "length": 255, @@ -103338,6 +104047,21 @@ "required": false, "type": "list" }, + { + "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": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, { "description": "", "length": 255, @@ -103358,13 +104082,6 @@ "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" } ], "related": "", @@ -103374,13 +104091,6 @@ "name": "id", "type": "string" }, - {}, - { - "description": "the name of the volume", - "name": "name", - "type": "string" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -103395,6 +104105,13 @@ "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.18.0" @@ -103439,89 +104156,100 @@ "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 start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the project name of the vlan range", + "name": "project", + "type": "string" + }, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, {}, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the end ip of the VLAN IP range", + "name": "endip", + "type": "string" }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "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": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { @@ -103530,14 +104258,14 @@ "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { "description": "the end ipv6 of the VLAN IP range", @@ -103545,14 +104273,8 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - {}, - { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { @@ -103561,13 +104283,8 @@ "type": "boolean" }, { - "description": "the ID of the VLAN IP range", - "name": "id", - "type": "string" - }, - { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ] @@ -103588,9 +104305,9 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { @@ -103598,16 +104315,16 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "4.19.0" @@ -103617,21 +104334,6 @@ "isasync": false, "name": "createProjectRolePermission", "params": [ - { - "description": "The rule permission, allow or deny. Default: deny.", - "length": 255, - "name": "permission", - "required": true, - "type": "string" - }, - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "The description of the role permission", "length": 255, @@ -103647,19 +104349,35 @@ "required": true, "type": "uuid" }, + { + "description": "The rule permission, allow or deny. Default: deny.", + "length": 255, + "name": "permission", + "required": true, + "type": "string" + }, { "description": "The API name or wildcard rule such as list*", "length": 255, "name": "rule", "required": true, "type": "string" + }, + { + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "", + "required": true, + "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the ID of the project role permission", - "name": "id", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { @@ -103668,18 +104386,19 @@ "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" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the description of the role permission", + "name": "description", "type": "string" }, + {}, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -103692,17 +104411,15 @@ "name": "projectrolename", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the project role permission", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", + "type": "string" } ], "since": "4.15.0" @@ -103713,23 +104430,23 @@ "name": "listRegisteredServicePackages", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -103737,31 +104454,31 @@ "related": "", "response": [ { - "description": "Service Package UUID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "Description of Service Package", - "name": "description", + "description": "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", + "description": "Description of Service Package", + "name": "description", "type": "string" }, { "description": "Service Package Name", "name": "name", "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -103788,26 +104505,18 @@ ], "related": "", "response": [ - { - "description": "the console url", - "name": "url", - "type": "string" - }, + {}, { "description": "true if the console endpoint is generated properly", "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the console websocket options", "name": "websocket", "type": "consoleendpointwebsocketresponse" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -103818,8 +104527,16 @@ "name": "details", "type": "string" }, - {}, - {} + { + "description": "the console url", + "name": "url", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.18.0" }, @@ -103829,18 +104546,17 @@ "name": "updateProjectRolePermission", "params": [ { - "description": "Project Role permission rule id", + "description": "Rule permission, can be: allow or deny", "length": 255, - "name": "projectrolepermissionid", - "related": "", + "name": "permission", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "ID of project where project role permission is to be updated", + "description": "ID of the project role", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "projectroleid", + "related": "", "required": true, "type": "uuid" }, @@ -103853,44 +104569,45 @@ "type": "list" }, { - "description": "ID of the project role", + "description": "Project Role permission rule id", "length": 255, - "name": "projectroleid", + "name": "projectrolepermissionid", "related": "", - "required": true, + "required": false, "type": "uuid" }, { - "description": "Rule permission, can be: allow or deny", + "description": "ID of project where project role permission is to be updated", "length": 255, - "name": "permission", - "required": false, - "type": "string" + "name": "projectid", + "related": "activateProject,suspendProject", + "required": true, + "type": "uuid" } ], "response": [ {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.15.0" }, @@ -103899,14 +104616,6 @@ "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, @@ -103916,11 +104625,12 @@ "type": "uuid" }, { - "description": "VM guest NIC secondary IP address for the port forwarding rule", + "description": "The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case)", "length": 255, - "name": "vmguestip", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of the virtual machine for enabling static NAT feature", @@ -103929,9 +104639,17 @@ "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": true, "type": "uuid" + }, + { + "description": "VM guest NIC secondary IP address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, + "type": "string" } ], "response": [ + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -103942,18 +104660,17 @@ "name": "displaytext", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -103972,26 +104689,26 @@ ], "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "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" } ] }, @@ -104000,6 +104717,13 @@ "isasync": true, "name": "addUserToProject", "params": [ + { + "description": "Name of the user to be added to the project", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, { "description": "ID of the project role", "length": 255, @@ -104015,13 +104739,6 @@ "required": false, "type": "string" }, - { - "description": "Name of the user to be added to the project", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, { "description": "ID of the project to add the user to", "length": 255, @@ -104039,23 +104756,23 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -104080,25 +104797,25 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -104109,13 +104826,6 @@ "isasync": true, "name": "deleteTungstenFabricFirewallPolicy", "params": [ - { - "description": "the uuid of Tungsten-Fabric firewall policy", - "length": 255, - "name": "firewallpolicyuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -104123,18 +104833,20 @@ "related": "createZone,listZones", "required": true, "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "required": true, + "type": "string" } ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { @@ -104142,11 +104854,16 @@ "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" } ] }, @@ -104167,380 +104884,234 @@ "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "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 NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - {}, { "description": "the id of userdata used for the VM", "name": "userdataid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "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", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, + {}, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, - {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "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 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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -104552,255 +105123,71 @@ "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "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 id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -104808,8 +105195,13 @@ "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", "type": "string" }, { @@ -104823,18 +105215,18 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -104843,32 +105235,27 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the id of the security group rule", @@ -104879,44 +105266,34 @@ "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", + "description": "the name of the security group", + "name": "name", "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, { "description": "the project name of the group", "name": "project", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" }, { "description": "the ID of the security group", @@ -104924,13 +105301,8 @@ "type": "string" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -104939,46 +105311,123 @@ "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" + "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 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": "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": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "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": "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 key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -104987,8 +105436,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -105002,26 +105451,21 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -105029,30 +105473,10 @@ "name": "securitygroupname", "type": "string" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" } ], "type": "set" @@ -105061,77 +105485,107 @@ "type": "set" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "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 account owning the affinity group", - "name": "account", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { @@ -105140,61 +105594,324 @@ "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "Type of adapter if available", + "name": "adaptertype", + "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" } ], "type": "set" }, + { + "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", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + {}, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, { "description": "State of the Service from LB rule", "name": "servicestate", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" } ] @@ -105205,45 +105922,60 @@ "name": "getUploadParamsForTemplate", "params": [ { - "description": "32 or 64 bits support. 64 by default", - "length": 255, - "name": "bits", + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", "required": false, - "type": "integer" + "type": "string" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "isextractable", + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the volume/template/iso", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "true if this template requires HVM", + "length": 255, + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "isfeatured", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the tag for this template.", + "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", "length": 255, - "name": "templatetag", + "name": "ostypeid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "format", - "required": true, - "type": "string" + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, "type": "string" }, @@ -105255,84 +105987,77 @@ "type": "boolean" }, { - "description": "Upload volume/template/iso for the project", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "sshkeyenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "ostypeid", - "related": "", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, "type": "uuid" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "isfeatured", + "name": "bits", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "ispublic", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "account", - "required": false, + "name": "format", + "required": true, "type": "string" }, { - "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "checksum", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the volume/template/iso", + "description": "the target hypervisor for the template", "length": 255, - "name": "name", + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "true if the template supports the password reset feature; default is false", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "passwordenabled", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "true if this template requires HVM", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "requireshvm", + "name": "deployasis", "required": false, + "since": "4.15.1", "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "Template details in key/value pairs.", "length": 255, - "name": "sshkeyenabled", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", @@ -105342,39 +106067,31 @@ "type": "boolean" }, { - "description": "Template details in key/value pairs.", + "description": "the tag for this template.", "length": 255, - "name": "details", + "name": "templatetag", "required": false, - "type": "map" - }, - { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": true, "type": "string" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "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": "deployasis", + "name": "checksum", "required": false, - "since": "4.15.1", - "type": "boolean" + "type": "string" } ], "related": "getUploadParamsForIso", "response": [ { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the timestamp after which the signature expires", @@ -105382,27 +106099,27 @@ "type": "string" }, {}, - { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", - "type": "string" - }, { "description": "signature to be sent in the POST request.", "name": "signature", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "the 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" }, @@ -105423,26 +106140,26 @@ "response": [ {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.17.0" }, @@ -105451,13 +106168,6 @@ "isasync": true, "name": "updateTungstenFabricLBHealthMonitor", "params": [ - { - "description": "loadbalancer health monitor expected code", - "length": 255, - "name": "expectedcode", - "required": false, - "type": "string" - }, { "description": "loadbalancer health monitor retry", "length": 255, @@ -105466,19 +106176,18 @@ "type": "integer" }, { - "description": "loadbalancer health monitor interval", + "description": "loadbalancer health monitor expected code", "length": 255, - "name": "interval", - "required": true, - "type": "integer" + "name": "expectedcode", + "required": false, + "type": "string" }, { - "description": "the ID of lb rule", + "description": "loadbalancer health monitor interval", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", + "name": "interval", "required": true, - "type": "uuid" + "type": "integer" }, { "description": "loadbalancer health monitor type", @@ -105488,11 +106197,11 @@ "type": "string" }, { - "description": "loadbalancer health monitor timeout", + "description": "loadbalancer health monitor http method", "length": 255, - "name": "timeout", - "required": true, - "type": "integer" + "name": "httpmethodtype", + "required": false, + "type": "string" }, { "description": "loadbalancer health monitor url path", @@ -105502,86 +106211,94 @@ "type": "string" }, { - "description": "loadbalancer health monitor http method", + "description": "loadbalancer health monitor timeout", "length": 255, - "name": "httpmethodtype", - "required": false, - "type": "string" + "name": "timeout", + "required": true, + "type": "integer" + }, + { + "description": "the ID of lb rule", + "length": 255, + "name": "lbruleid", + "related": "updateIpv6FirewallRule", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the health monitor http method", - "name": "httpmethod", + "description": "the health monitor expected code", + "name": "expectedcode", "type": "string" }, { - "description": "the health monitor UUID", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the health monitor interval", - "name": "interval", - "type": "int" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { "description": "the health monitor type", "name": "type", "type": "string" }, + { + "description": "the health monitor timeout", + "name": "timeout", + "type": "int" + }, + {}, + { + "description": "the health monitor retry", + "name": "retry", + "type": "int" + }, { "description": "the LB rule ID", "name": "lbruleid", "type": "string" }, { - "description": "the health monitor expected code", - "name": "expectedcode", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the health monitor url path", "name": "urlpath", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the health monitor retry", - "name": "retry", + "description": "the health monitor interval", + "name": "interval", "type": "int" }, { - "description": "the health monitor timeout", - "name": "timeout", - "type": "int" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, { "description": "the health monitor ID", "name": "id", "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the health monitor UUID", + "name": "uuid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the health monitor http method", + "name": "httpmethod", + "type": "string" } ] }, @@ -105594,7 +106311,7 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } @@ -105603,9 +106320,9 @@ {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "any text associated with the success or failure", @@ -105613,9 +106330,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "true if operation is executed successfully", @@ -105629,6 +106346,13 @@ "isasync": true, "name": "updateProjectInvitation", "params": [ + { + "description": "account that is joining the project", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "User UUID, required for adding account from external provisioning system", "length": 255, @@ -105637,6 +106361,13 @@ "required": false, "type": "uuid" }, + { + "description": "if true, accept the invitation, decline if false. True by default", + "length": 255, + "name": "accept", + "required": false, + "type": "boolean" + }, { "description": "list invitations for specified account; this parameter has to be specified with domainId", "length": 255, @@ -105651,20 +106382,6 @@ "related": "activateProject,suspendProject", "required": true, "type": "uuid" - }, - { - "description": "if true, accept the invitation, decline if false. True by default", - "length": 255, - "name": "accept", - "required": false, - "type": "boolean" - }, - { - "description": "account that is joining the project", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "response": [ @@ -105710,54 +106427,54 @@ "related": "listSnapshots", "response": [ { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, { "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", "name": "state", "type": "state" }, - {}, { - "description": "ID of the snapshot", - "name": "id", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the status of the template", + "name": "status", + "type": "string" }, + {}, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { @@ -105765,28 +106482,23 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -105795,89 +106507,83 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { "description": "id of the resource", "name": "resourceid", "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, - {}, { "description": "name of the availability zone", "name": "zonename", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "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": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, { "description": "virtual size of backedup snapshot on image store", "name": "virtualsize", @@ -105888,39 +106594,50 @@ "name": "revertable", "type": "boolean" }, + {}, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "name of the snapshot", + "name": "name", "type": "string" } ] @@ -105931,11 +106648,12 @@ "name": "updateCondition", "params": [ { - "description": "Value for which the Counter will be evaluated with the Operator selected.", + "description": "the ID of the condition.", "length": 255, - "name": "threshold", + "name": "id", + "related": "", "required": true, - "type": "long" + "type": "uuid" }, { "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", @@ -105945,25 +106663,23 @@ "type": "string" }, { - "description": "the ID of the condition.", + "description": "Value for which the Counter will be evaluated with the Operator selected.", "length": 255, - "name": "id", - "related": "", + "name": "threshold", "required": true, - "type": "uuid" + "type": "long" } ], "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", @@ -105971,10 +106687,11 @@ "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.18.0" @@ -105984,6 +106701,13 @@ "isasync": false, "name": "listRegions", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -105999,11 +106723,11 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "List Region by region name.", @@ -106011,22 +106735,26 @@ "name": "name", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "addRegion", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the ID of the region", + "name": "id", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" }, + {}, { "description": "the end point of the region", "name": "endpoint", @@ -106043,20 +106771,9 @@ "type": "string" }, { - "description": "the ID of the region", - "name": "id", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {} ] @@ -106066,13 +106783,6 @@ "isasync": true, "name": "configureInternalLoadBalancerElement", "params": [ - { - "description": "Enables/Disables the Internal Load Balancer element", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - }, { "description": "the ID of the internal lb provider", "length": 255, @@ -106080,36 +106790,43 @@ "related": "configureInternalLoadBalancerElement", "required": true, "type": "uuid" + }, + { + "description": "Enables/Disables the Internal Load Balancer element", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" } ], "related": "", "response": [ - { - "description": "the physical network service provider id of the element", - "name": "nspid", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting 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 internal load balancer element", "name": "id", "type": "string" }, + { + "description": "the physical network service provider id of the element", + "name": "nspid", + "type": "string" + }, { "description": "Enabled/Disabled the element", "name": "enabled", "type": "boolean" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {} ], "since": "4.2.0" @@ -106129,19 +106846,19 @@ "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "destination Host ID to migrate VM to", "length": 255, - "name": "virtualmachineid", - "related": "migrateSystemVm", - "required": true, + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "required": false, "type": "uuid" }, { - "description": "destination Host ID to migrate VM to", + "description": "the ID of the virtual machine", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": false, + "name": "virtualmachineid", + "related": "migrateSystemVm", + "required": true, "type": "uuid" }, { @@ -106156,40 +106873,38 @@ "related": "", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, - {}, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, - {}, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { @@ -106198,38 +106913,33 @@ "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { @@ -106238,98 +106948,115 @@ "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the template ID for the system VM", "name": "templateid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, + {}, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", + "description": "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 Zone ID for the system VM", - "name": "zoneid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, + {}, { - "description": "the name of the system VM", - "name": "name", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the 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": "the ID of the system VM", - "name": "id", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { @@ -106338,33 +107065,23 @@ "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" } ] @@ -106375,18 +107092,18 @@ "name": "listCounters", "params": [ { - "description": "List by keyword", + "description": "Source of the counter.", "length": 255, - "name": "keyword", + "name": "source", "required": false, "type": "string" }, { - "description": "", + "description": "Name of the counter.", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "ID of the Counter.", @@ -106396,13 +107113,6 @@ "required": false, "type": "uuid" }, - { - "description": "Name of the counter.", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "Network provider of the counter.", "length": 255, @@ -106414,24 +107124,30 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "Source of the counter.", + "description": "List by keyword", "length": 255, - "name": "source", + "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createCounter", "response": [ - {}, { - "description": "Source of the counter.", - "name": "source", + "description": "Name of the counter.", + "name": "name", "type": "string" }, { @@ -106440,8 +107156,13 @@ "type": "integer" }, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "Provider of the counter.", + "name": "provider", + "type": "string" + }, + { + "description": "Source of the counter.", + "name": "source", "type": "string" }, { @@ -106450,25 +107171,21 @@ "type": "string" }, {}, + {}, { - "description": "Name of the counter.", - "name": "name", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, { - "description": "Provider of the counter.", - "name": "provider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the id of the Counter", "name": "id", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -106477,13 +107194,6 @@ "isasync": true, "name": "removeTungstenFabricTag", "params": [ - { - "description": "the uuid of vms", - "length": 255, - "name": "vmuuid", - "required": false, - "type": "list" - }, { "description": "the uuid of Tungsten-Fabric policy", "length": 255, @@ -106498,6 +107208,21 @@ "required": true, "type": "string" }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the uuid of networks", + "length": 255, + "name": "networkuuid", + "required": false, + "type": "list" + }, { "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, @@ -106506,24 +107231,16 @@ "type": "string" }, { - "description": "the uuid of nics", + "description": "the uuid of vms", "length": 255, - "name": "nicuuid", + "name": "vmuuid", "required": false, "type": "list" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the uuid of networks", + "description": "the uuid of nics", "length": 255, - "name": "networkuuid", + "name": "nicuuid", "required": false, "type": "list" } @@ -106531,30 +107248,29 @@ "related": "createTungstenFabricTag", "response": [ { - "description": "list Tungsten-Fabric vm", - "name": "vm", + "description": "list Tungsten-Fabric policy", + "name": "policy", "type": "list" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, {}, { - "description": "list Tungsten-Fabric network", - "name": "network", + "description": "list Tungsten-Fabric vm", + "name": "vm", "type": "list" }, { @@ -106562,25 +107278,26 @@ "name": "name", "type": "string" }, + {}, { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -106597,18 +107314,18 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "list network offerings by enabled state", "length": 255, - "name": "keyword", + "name": "enabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "list virtual router elements by network service provider id", @@ -106619,23 +107336,40 @@ "type": "uuid" }, { - "description": "list virtual router elements by id", + "description": "", "length": 255, - "name": "id", - "related": "listVirtualRouterElements", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list network offerings by enabled state", + "description": "list virtual router elements by id", "length": 255, - "name": "enabled", + "name": "id", + "related": "listVirtualRouterElements", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "", "response": [ + { + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the account associated with the provider", + "name": "account", + "type": "string" + }, + {}, + {}, { "description": "Enabled/Disabled the service provider", "name": "enabled", @@ -106647,14 +107381,8 @@ "type": "integer" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "type": "string" - }, - {}, - { - "description": "the account associated with the provider", - "name": "account", + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -106672,21 +107400,10 @@ "name": "jobid", "type": "string" }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - {}, { "description": "the project id of the ipaddress", "name": "projectid", "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" } ] }, @@ -106723,18 +107440,18 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + {} ] }, { @@ -106750,16 +107467,16 @@ "type": "integer" }, { - "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", + "description": "List by keyword", "length": 255, - "name": "traffictype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", "length": 255, - "name": "keyword", + "name": "traffictype", "required": false, "type": "string" }, @@ -106778,6 +107495,11 @@ "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "implementor of network traffic type", "name": "traffictypeimplementor", @@ -106789,11 +107511,6 @@ "description": "network traffic type", "name": "traffictype", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "3.0.0" @@ -106804,20 +107521,26 @@ "name": "linkAccountToLdap", "params": [ { - "description": "The id of the domain that is to contain the linked account.", + "description": "domain admin username in LDAP ", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" + "name": "admin", + "required": false, + "type": "string" }, { - "description": "name of the account, it will be created if it does not exist", + "description": "name of the group or OU in LDAP", "length": 255, - "name": "account", + "name": "ldapdomain", "required": true, "type": "string" }, + { + "description": "type of the ldap name. GROUP or OU, defaults to GROUP", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, { "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", "length": 255, @@ -106826,44 +107549,32 @@ "type": "integer" }, { - "description": "domain admin username in LDAP ", - "length": 255, - "name": "admin", - "required": false, - "type": "string" - }, - { - "description": "name of the group or OU in LDAP", + "description": "name of the account, it will be created if it does not exist", "length": 255, - "name": "ldapdomain", + "name": "account", "required": true, "type": "string" }, { - "description": "type of the ldap name. GROUP or OU, defaults to GROUP", + "description": "The id of the domain that is to contain the linked account.", "length": 255, - "name": "type", - "required": false, - "type": "string" + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - {}, { "description": "Domain Admin accountId that is created", "name": "accountid", "type": "string" }, { - "description": "type of the name in LDAP which is linked to the domain", - "name": "type", - "type": "string" - }, - { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -106871,26 +107582,32 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of the Domain which is linked to LDAP", + "name": "domainid", + "type": "string" + }, + { + "description": "Type of the account to auto import", + "name": "accounttype", + "type": "int" }, + {}, { "description": "name of the group or OU in LDAP which is linked to the domain", "name": "name", "type": "string" }, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", "type": "string" }, + {}, { "description": "name of the group or OU in LDAP which is linked to the domain", "name": "ldapdomain", "type": "string" - }, - {} + } ], "since": "4.11.0" }, @@ -106901,37 +107618,51 @@ "params": [], "related": "", "response": [ - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the number of queries performed on the DB", + "name": "queries", + "type": "long" + }, + { + "description": "the state of the usage server", + "name": "replicas", + "type": "string[]" + }, { "description": "the number of connections to the DB", "name": "connections", "type": "int" }, { - "description": "the version of the currently running DB", - "name": "version", + "description": "the tls versions currently in use (accepted) by the DB", + "name": "tlsversions", "type": "string" }, { - "description": "the version of the currently running DB", - "name": "versioncomment", - "type": "string" + "description": "the 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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the version of the currently running DB", + "name": "version", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the last measured load averages on the DB", + "name": "dbloadaverages", + "type": "double[]" }, { "description": "the uptime of the DB in seconds", @@ -106939,30 +107670,16 @@ "type": "long" }, { - "description": "the tls versions currently in use (accepted) by the DB", - "name": "tlsversions", + "description": "the name of the active usage server", + "name": "hostname", "type": "string" }, { - "description": "the last measured load averages on the DB", - "name": "dbloadaverages", - "type": "double[]" - }, - { - "description": "the number of queries performed on the DB", - "name": "queries", - "type": "long" - }, - { - "description": "the state of the usage server", - "name": "replicas", - "type": "string[]" - }, - { - "description": "the name of the active usage server", - "name": "hostname", + "description": "the version of the currently running DB", + "name": "versioncomment", "type": "string" - } + }, + {} ], "since": "4.17.0" }, @@ -106981,28 +107698,28 @@ } ], "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.2.0" }, @@ -107012,36 +107729,49 @@ "name": "listAutoScaleVmProfiles", "params": [ { - "description": "list profiles by service offering id", + "description": "the otherdeployparameters of the autoscale vm profile", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "otherdeployparams", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "availability zone for the auto deployed virtual machine", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", "required": false, "since": "4.4", "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the templateid of the autoscale vm profile", "length": 255, - "name": "fordisplay", + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the autoscale vm profile", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "createAutoScaleVmProfile,listAutoScaleVmProfiles", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list only resources belonging to the domain specified", @@ -107052,27 +107782,27 @@ "type": "uuid" }, { - "description": "the otherdeployparameters of the autoscale vm profile", + "description": "List by keyword", "length": 255, - "name": "otherdeployparams", + "name": "keyword", "required": false, "type": "string" }, { - "description": "availability zone for the auto deployed virtual machine", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the autoscale vm profile", "length": 255, - "name": "account", + "name": "id", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -107089,18 +107819,12 @@ "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the templateid of the autoscale vm profile", + "description": "list profiles by service offering id", "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { @@ -107110,60 +107834,44 @@ "related": "activateProject,suspendProject", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "createAutoScaleVmProfile", "response": [ + {}, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" - }, - { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -107172,46 +107880,45 @@ "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "Base 64 encoded VM user data", + "name": "userdata", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, {}, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", - "type": "string" + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "description": "the domain ID of the vm profile", + "name": "domainid", + "type": "string" }, + {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, { @@ -107220,11 +107927,21 @@ "type": "string" }, { - "description": "Base 64 encoded VM user data", - "name": "userdata", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, - {} + { + "description": "the project id vm profile", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -107236,67 +107953,68 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", "response": [ + {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the out-of-band management interface port", - "name": "port", + "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", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" }, + {}, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, - {}, { - "description": "the operation result", - "name": "status", + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", "type": "boolean" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -107304,11 +108022,10 @@ "name": "description", "type": "string" }, - {}, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the operation result", + "name": "status", + "type": "boolean" } ], "since": "4.9.0" @@ -107322,52 +108039,123 @@ "description": "host ID", "length": 255, "name": "id", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } ], - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "response": [ { - "description": "events available for the host", - "name": "events", + "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 memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the host version", + "name": "version", + "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 IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, { "description": "true if local storage is active, false otherwise", "name": "islocalstorageactive", "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "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 amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "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 last annotation set on this host by an admin", - "name": "annotation", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + {}, + { + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", @@ -107375,14 +108163,14 @@ "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { "description": "GPU cards present in the host", @@ -107398,18 +108186,8 @@ "name": "vgpu", "response": [ { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { @@ -107423,10 +108201,15 @@ "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, { "description": "Video RAM for this vGPU type", "name": "videoram", @@ -107436,6 +108219,11 @@ "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" } ], "type": "list" @@ -107444,85 +108232,74 @@ "type": "list" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "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", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "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 Zone name of the host", - "name": "zonename", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, - {}, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { "description": "the OS category name of the host", @@ -107530,175 +108307,115 @@ "type": "string" }, { - "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": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, + {}, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "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": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host version", - "name": "version", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "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", + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, { "description": "the host type", "name": "type", "type": "type" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - {}, - { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the date and time the host was removed", - "name": "removed", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, { - "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" } ], "since": "4.16.0.0" @@ -107709,24 +108426,25 @@ "name": "authorizeSecurityGroupIngress", "params": [ { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "an optional project of the security group", "length": 255, - "name": "securitygroupname", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "user to security group mapping", "length": 255, - "name": "account", + "name": "usersecuritygrouplist", "required": false, - "type": "string" + "type": "map" }, { - "description": "an optional project of the security group", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, @@ -107738,95 +108456,84 @@ "type": "integer" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "description": "start port for this ingress rule", "length": 255, - "name": "cidrlist", + "name": "startport", "required": false, - "type": "list" + "type": "integer" }, { - "description": "error code for this icmp message", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "icmpcode", + "name": "securitygroupid", + "related": "createSecurityGroup", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "user to security group mapping", + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "usersecuritygrouplist", + "name": "cidrlist", "required": false, - "type": "map" + "type": "list" }, { - "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": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "protocol", + "name": "account", "required": false, "type": "string" }, { - "description": "start port for this ingress rule", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.", "length": 255, - "name": "startport", + "name": "protocol", "required": false, - "type": "integer" + "type": "string" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "end port for this ingress rule", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup", + "name": "endport", "required": false, - "type": "uuid" + "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 security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "securitygroupname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "end port for this ingress rule", + "description": "error code for this icmp message", "length": 255, - "name": "endport", + "name": "icmpcode", "required": false, "type": "integer" } ], "related": "", "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": "security group name", - "name": "securitygroupname", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, + {}, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -107834,28 +108541,28 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -107864,53 +108571,63 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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 code for the ICMP message response", - "name": "icmpcode", + "description": "the current status of the latest async job acting 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 security group rule", "name": "ruleid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "security group name", + "name": "securitygroupname", "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ] }, @@ -107931,15 +108648,35 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "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 storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", @@ -107951,132 +108688,112 @@ "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, + {}, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "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 ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, + {}, { "description": "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 IP address of the storage pool", - "name": "ipaddress", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "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", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - }, { "description": "the hypervisor type of the storage pool", "name": "hypervisor", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" - }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" - }, - {} + } ], "since": "4.15.1" }, @@ -108086,12 +108803,11 @@ "name": "createSecurityGroup", "params": [ { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "name of the security group", @@ -108101,54 +108817,59 @@ "type": "string" }, { - "description": "Create security group for project", + "description": "the description of the security group", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the description of the security group", + "description": "Create security group for project", "length": 255, - "name": "description", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -108162,18 +108883,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -108182,89 +108898,60 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, + {}, { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "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 account associated with the tag", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "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" }, { @@ -108278,31 +108965,21 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the 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 type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -108311,14 +108988,14 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "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", @@ -108326,26 +109003,56 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "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 CIDR notation for the base IP address of the security group rule", @@ -108353,18 +109060,23 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -108372,33 +109084,33 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the 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": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -108407,28 +109119,23 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the id of the security group rule", "name": "ruleid", @@ -108440,27 +109147,37 @@ "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" } ], "type": "set" }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, { "description": "the domain name of the security group", "name": "domain", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "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 description of the security group", + "name": "description", + "type": "string" } ] }, @@ -108481,8 +109198,8 @@ "related": "", "response": [ { - "description": "the ID of project the network is available for", - "name": "projectid", + "description": "the account the network is available for", + "name": "account", "type": "string" }, { @@ -108490,15 +109207,15 @@ "name": "project", "type": "string" }, + {}, { - "description": "the ID of account the network is available for", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the network ID", - "name": "networkid", + "description": "the ID of the domain to which the network belongs", + "name": "domainid", "type": "string" }, {}, @@ -108508,18 +109225,18 @@ "type": "integer" }, { - "description": "the account the network is available for", - "name": "account", + "description": "the network ID", + "name": "networkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of account the network is available for", + "name": "accountid", "type": "string" }, { - "description": "the ID of the domain to which the network belongs", - "name": "domainid", + "description": "the ID of project the network is available for", + "name": "projectid", "type": "string" }, { @@ -108535,6 +109252,13 @@ "isasync": false, "name": "updateBucket", "params": [ + { + "description": "Bucket Access Policy", + "length": 255, + "name": "policy", + "required": false, + "type": "string" + }, { "description": "The ID of the Bucket", "length": 255, @@ -108543,13 +109267,6 @@ "required": true, "type": "uuid" }, - { - "description": "Bucket Quota in GB", - "length": 255, - "name": "quota", - "required": false, - "type": "integer" - }, { "description": "Enable/Disable Bucket Versioning", "length": 255, @@ -108558,21 +109275,22 @@ "type": "boolean" }, { - "description": "Bucket Access Policy", + "description": "Enable/Disable Bucket encryption", "length": 255, - "name": "policy", + "name": "encryption", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Enable/Disable Bucket encryption", + "description": "Bucket Quota in GB", "length": 255, - "name": "encryption", + "name": "quota", "required": false, - "type": "boolean" + "type": "integer" } ], "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -108583,17 +109301,16 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {} ], "since": "4.19.0" @@ -108603,13 +109320,6 @@ "isasync": false, "name": "updateResourceCount", "params": [ - { - "description": "Update resource count for a specified account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "Update resource limits for project", "length": 255, @@ -108618,6 +109328,13 @@ "required": false, "type": "uuid" }, + { + "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "length": 255, + "name": "resourcetype", + "required": false, + "type": "integer" + }, { "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, @@ -108627,18 +109344,23 @@ "type": "uuid" }, { - "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "Update resource count for a specified account. Must be used with the domainId parameter.", "length": 255, - "name": "resourcetype", + "name": "account", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the domain name for which resource count's are updated", - "name": "domain", + "description": "the project id for which resource count's are updated", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID for which resource count's are updated", + "name": "domainid", "type": "string" }, { @@ -108646,48 +109368,43 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the project id for which resource count's are updated", - "name": "projectid", - "type": "string" - }, { "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", "name": "resourcetypename", "type": "string" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "resource count", - "name": "resourcecount", - "type": "long" + "description": "the domain name for which resource count's are updated", + "name": "domain", + "type": "string" }, + {}, { "description": "the account for which resource count's are updated", "name": "account", "type": "string" }, - {}, { - "description": "the domain ID for which resource count's are updated", - "name": "domainid", - "type": "string" + "description": "resource count", + "name": "resourcecount", + "type": "long" }, - {}, { "description": "the project name for which resource count's are updated", "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", + "name": "resourcetype", "type": "string" - } + }, + {} ] }, { @@ -108696,25 +109413,25 @@ "name": "listVpnGateways", "params": [ { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "id of the vpn gateway", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "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": "activateProject,suspendProject", "required": false, "type": "uuid" }, @@ -108726,11 +109443,20 @@ "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "id of vpc", "length": 255, - "name": "listall", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "id of the vpn gateway", + "length": 255, + "name": "id", + "related": "createVpnGateway,listVpnGateways", + "required": false, + "type": "uuid" }, { "description": "", @@ -108747,47 +109473,33 @@ "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isrecursive", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "fordisplay", + "name": "listall", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "createVpnGateway", "response": [ { - "description": "the owner", - "name": "account", - "type": "string" - }, - { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -108796,39 +109508,45 @@ "type": "integer" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the vpn gateway ID", + "name": "id", + "type": "string" }, - {}, { - "description": "the public IP address", - "name": "publicip", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, + {}, { - "description": "the project id", - "name": "projectid", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, { @@ -108837,16 +109555,15 @@ "type": "date" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { "description": "the domain name of the owner", "name": "domain", "type": "string" - }, - {} + } ] }, { @@ -108855,18 +109572,11 @@ "name": "listRoles", "params": [ { - "description": "List role by role name.", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "description": "", "length": 255, - "name": "type", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "List role by role ID.", @@ -108877,16 +109587,16 @@ "type": "uuid" }, { - "description": "", + "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", "length": 255, - "name": "pagesize", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "List role by role name.", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, @@ -108896,51 +109606,58 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "importRole", "response": [ - {}, { - "description": "the ID of the role", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "the description of the role", + "name": "description", "type": "string" }, {}, + {}, { "description": "true if role is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the name of the role", + "name": "name", "type": "string" }, { "description": "the type of the role", "name": "type", "type": "string" + }, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" } ], "since": "4.9.0" @@ -108950,13 +109667,6 @@ "isasync": false, "name": "listTungstenFabricPolicy", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "the ID of network", "length": 255, @@ -108966,27 +109676,25 @@ "type": "uuid" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "", "length": 255, - "name": "policyuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of ip address", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "policyuuid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "List by keyword", @@ -108996,53 +109704,62 @@ "type": "string" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "the ID of ip address", + "length": 255, + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {}, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, + {}, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - {}, { "description": "Tungsten-Fabric tag type uuid", "name": "uuid", "type": "string" - }, - {} + } ] }, { @@ -109050,13 +109767,6 @@ "isasync": true, "name": "downloadImageStoreObject", "params": [ - { - "description": "path to download on image store", - "length": 255, - "name": "path", - "required": false, - "type": "string" - }, { "description": "id of the image store", "length": 255, @@ -109064,44 +109774,46 @@ "related": "listSwifts,addImageStoreS3,listImageStores", "required": true, "type": "uuid" + }, + { + "description": "path to download on image store", + "length": 255, + "name": "path", + "required": false, + "type": "string" } ], "related": "extractTemplate", "response": [ { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" - }, - { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "", + "name": "resultstring", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "type of the storage", + "name": "storagetype", "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": "type of the storage", - "name": "storagetype", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { @@ -109110,24 +109822,23 @@ "type": "string" }, { - "description": "the current status of the latest async job acting 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 upload id of extracted object", - "name": "extractId", - "type": "string" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "the status of the extraction", - "name": "status", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, - {}, { - "description": "the name of the extracted object", - "name": "name", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { @@ -109136,20 +109847,26 @@ "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 time and date the object was created", + "name": "created", + "type": "date" + }, + { + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the id of extracted object", - "name": "id", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the status of the extraction", + "name": "status", "type": "string" - } + }, + {} ], "since": "4.19.0" }, @@ -109175,26 +109892,26 @@ "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 cloud identifier", "name": "cloudidentifier", "type": "string" }, - {}, { "description": "the signed response for the cloud identifier", "name": "signature", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -109203,6 +109920,21 @@ "isasync": true, "name": "createLBStickinessPolicy", "params": [ + { + "description": "name of the load balancer stickiness policy", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", "length": 255, @@ -109224,13 +109956,6 @@ "required": false, "type": "string" }, - { - "description": "name of the load balancer stickiness policy", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the ID of the load balancer rule", "length": 255, @@ -109238,35 +109963,41 @@ "related": "updateIpv6FirewallRule", "required": true, "type": "uuid" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" } ], "related": "listLBStickinessPolicies", "response": [ { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" }, + {}, { "description": "the domain ID of the Stickiness policy", "name": "domainid", "type": "string" }, - {}, - {}, + { + "description": "the 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 LB rule ID", "name": "lbruleid", @@ -109278,24 +110009,14 @@ "type": "string" }, { - "description": "the domain of the Stickiness policy", - "name": "domain", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ - { - "description": "the method name of the Stickiness policy", - "name": "methodname", - "type": "string" - }, { "description": "is policy for display to the regular user", "name": "fordisplay", @@ -109306,11 +110027,6 @@ "name": "state", "type": "string" }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, { "description": "the params of the policy", "name": "params", @@ -109321,29 +110037,30 @@ "name": "id", "type": "string" }, + { + "description": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" + }, { "description": "the description of the Stickiness policy", "name": "description", "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" }, - { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", - "type": "string" - } + {} ], "since": "3.0.0" }, @@ -109353,27 +110070,19 @@ "name": "addCiscoAsa1000vResource", "params": [ { - "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" - }, - { - "description": "the Physical Network ID", + "description": "the Cluster ID", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "clusterid", + "related": "addCluster", "required": true, "type": "uuid" }, { - "description": "the Cluster ID", + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "hostname", "required": true, - "type": "uuid" + "type": "string" }, { "description": "Nexus port profile associated with inside interface of ASA 1000v", @@ -109381,11 +110090,18 @@ "name": "insideportprofile", "required": true, "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - {}, {}, {}, { @@ -109393,6 +110109,7 @@ "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -109427,19 +110144,15 @@ ], "related": "addPaloAltoFirewall,listPaloAltoFirewalls", "response": [ + {}, { - "description": "name of the provider", - "name": "provider", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "device state", - "name": "fwdevicestate", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { @@ -109448,59 +110161,59 @@ "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 username that's used to log in to the external firewall", - "name": "username", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, - { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, { "description": "the public security zone of the external firewall", "name": "publiczone", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, {}, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { @@ -109509,14 +110222,18 @@ "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, + { + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, - {}, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "name of the provider", + "name": "provider", "type": "string" } ] @@ -109527,23 +110244,16 @@ "name": "updateNetworkACLItem", "params": [ { - "description": "scl entry action, allow or deny", + "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "action", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - }, - { - "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "traffictype", + "name": "reason", "required": false, "type": "string" }, @@ -109555,27 +110265,20 @@ "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ID of the network ACL item", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "id", + "related": "updateNetworkACLItem,moveNetworkAclItem", + "required": true, + "type": "uuid" }, { - "description": "error code for this ICMP message", + "description": "The network of the vm the ACL will be created for", "length": 255, - "name": "icmpcode", + "name": "number", "required": false, "type": "integer" }, - { - "description": "A description indicating why the ACL rule is required.", - "length": 255, - "name": "reason", - "required": false, - "type": "string" - }, { "description": "Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.", "length": 255, @@ -109584,11 +110287,11 @@ "type": "boolean" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "protocol", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { "description": "the ending port of ACL", @@ -109598,27 +110301,34 @@ "type": "integer" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "error code for this ICMP message", "length": 255, - "name": "cidrlist", + "name": "icmpcode", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the ID of the network ACL item", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "id", - "related": "updateNetworkACLItem,moveNetworkAclItem", - "required": true, - "type": "uuid" + "name": "protocol", + "required": false, + "type": "string" }, { - "description": "The network of the vm the ACL will be created for", + "description": "type of the ICMP message being sent", "length": 255, - "name": "number", + "name": "icmptype", "required": false, "type": "integer" }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -109626,15 +110336,89 @@ "required": false, "since": "4.4", "type": "string" + }, + { + "description": "scl entry action, allow or deny", + "length": 255, + "name": "action", + "required": false, + "type": "string" } ], "related": "moveNetworkAclItem", "response": [ + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the starting port of ACL's port range", + "name": "startport", + "type": "string" + }, + { + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" + }, { "description": "the ID of the ACL Item", "name": "id", "type": "string" }, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + {}, + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + { + "description": "the 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": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" + }, + { + "description": "the protocol of the ACL", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" + }, + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", @@ -109645,38 +110429,38 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -109685,94 +110469,27 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, { "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", - "type": "string" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - {}, - { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "the name of the ACL this item belongs to", - "name": "aclname", - "type": "string" - }, - {}, { "description": "the state of the rule", "name": "state", "type": "string" }, - { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" - }, - { - "description": "the ending port of ACL's port range", - "name": "endport", - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" - }, - { - "description": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" } ] }, @@ -109806,16 +110523,6 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -109827,6 +110534,16 @@ "type": "string" }, {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ], "since": "4.11" @@ -109837,53 +110554,40 @@ "name": "listRouters", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the cluster ID of the router", + "description": "the Pod ID of the router", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the name of the router", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "if this parameter is passed, list only routers by health check results", "length": 255, - "name": "isrecursive", + "name": "healthchecksfailed", "required": false, + "since": "4.16", "type": "boolean" }, { - "description": "List networks by VPC", + "description": "the ID of the disk router", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "id", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", "required": false, "type": "uuid" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list virtual router elements by version", + "description": "the name of the router", "length": 255, - "name": "version", + "name": "name", "required": false, "type": "string" }, @@ -109896,18 +110600,18 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the state of the router", "length": 255, - "name": "account", + "name": "state", "required": false, "type": "string" }, { - "description": "", + "description": "list virtual router elements by version", "length": 255, - "name": "pagesize", + "name": "version", "required": false, - "type": "integer" + "type": "string" }, { "description": "list only resources belonging to the domain specified", @@ -109918,19 +110622,26 @@ "type": "uuid" }, { - "description": "the state of the router", + "description": "List networks by VPC", "length": 255, - "name": "state", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the host ID of the router", + "description": "", "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "the Zone ID of the router", @@ -109941,13 +110652,20 @@ "type": "uuid" }, { - "description": "the ID of the disk router", + "description": "the host ID of the 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,importUnmanagedInstance,importVm", + "name": "hostid", + "related": "addBaremetalHost,reconnectHost", "required": false, "type": "uuid" }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "if true is passed for this parameter, list only VPC routers", "length": 255, @@ -109964,20 +110682,26 @@ "type": "boolean" }, { - "description": "the Pod ID of the router", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "the cluster ID of the router", + "length": 255, + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, { - "description": "if this parameter is passed, list only routers by health check results", + "description": "List by keyword", "length": 255, - "name": "healthchecksfailed", + "name": "keyword", "required": false, - "since": "4.16", - "type": "boolean" + "type": "string" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -109986,46 +110710,50 @@ "related": "activateProject,suspendProject", "required": false, "type": "uuid" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" } ], "related": "destroyRouter", "response": [ { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + } + ], + "type": "list" }, - {}, { - "description": "role of the domain router", - "name": "role", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, {}, @@ -110035,108 +110763,33 @@ "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "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": "VPC the router belongs to", - "name": "vpcid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, { "description": "the state of redundant virtual router", "name": "redundantstate", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the Pod name for the router", + "name": "podname", "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" }, { @@ -110149,8 +110802,23 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -110164,18 +110832,28 @@ "type": "integer" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "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" }, { @@ -110184,18 +110862,18 @@ "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -110209,8 +110887,8 @@ "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -110219,38 +110897,28 @@ "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", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -110259,18 +110927,13 @@ "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -110279,76 +110942,96 @@ "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" } ], "type": "set" }, { - "description": "the version of template", - "name": "version", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "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 domain associated with the router", - "name": "domain", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "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": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the name of the router", + "name": "name", + "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { @@ -110361,86 +111044,95 @@ "name": "dns1", "type": "string" }, + {}, { - "description": "the name of the router", - "name": "name", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - } - ], - "type": "list" + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { @@ -110449,13 +111141,38 @@ "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" } ] @@ -110469,17 +111186,24 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": true, "type": "uuid" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -110489,14 +111213,7 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + } ] }, { @@ -110504,13 +111221,6 @@ "isasync": false, "name": "listTungstenFabricVm", "params": [ - { - "description": "the uuid of Tungsten-Fabric vm", - "length": 255, - "name": "vmuuid", - "required": false, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -110519,6 +111229,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "List by keyword", "length": 255, @@ -110534,11 +111251,11 @@ "type": "integer" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric vm", "length": 255, - "name": "page", + "name": "vmuuid", "required": false, - "type": "integer" + "type": "string" } ], "related": "", @@ -110548,16 +111265,21 @@ "name": "uuid", "type": "string" }, + {}, + {}, + { + "description": "Tungsten-Fabric vm name", + "name": "name", + "type": "string" + }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, - {}, - {}, { - "description": "Tungsten-Fabric vm name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -110569,11 +111291,6 @@ "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -110582,6 +111299,14 @@ "isasync": true, "name": "createVpnConnection", "params": [ + { + "description": "id of the vpn gateway", + "length": 255, + "name": "s2svpngatewayid", + "related": "createVpnGateway", + "required": true, + "type": "uuid" + }, { "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, @@ -110598,14 +111323,6 @@ "required": true, "type": "uuid" }, - { - "description": "id of the vpn gateway", - "length": 255, - "name": "s2svpngatewayid", - "related": "createVpnGateway", - "required": true, - "type": "uuid" - }, { "description": "connection is passive or not", "length": 255, @@ -110616,20 +111333,9 @@ ], "related": "", "response": [ - {}, - { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the public IP address", - "name": "publicip", - "type": "string" - }, { - "description": "the project name", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -110643,18 +111349,18 @@ "type": "boolean" }, { - "description": "the owner", - "name": "account", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -110663,19 +111369,24 @@ "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the project name", + "name": "project", + "type": "string" }, { "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", @@ -110683,19 +111394,14 @@ "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, {}, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" - }, - { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { @@ -110704,28 +111410,18 @@ "type": "long" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", + "description": "is connection for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { @@ -110733,25 +111429,46 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, { "description": "the date and time the host was created", "name": "created", "type": "date" }, + {}, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the public IP address", + "name": "publicip", + "type": "string" + }, + { + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { "description": "the customer gateway ID", "name": "s2scustomergatewayid", "type": "string" + }, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "the connection ID", + "name": "id", + "type": "string" + }, + { + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "State of vpn connection", + "name": "state", + "type": "string" } ] }, @@ -110761,11 +111478,18 @@ "name": "listBrocadeVcsDeviceNetworks", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { "description": "brocade vcs switch ID", @@ -110776,212 +111500,125 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, + {}, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { "description": "true if guest network default egress policy is allow; false if default egress policy is deny", @@ -110989,58 +111626,58 @@ "type": "boolean" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { @@ -111049,249 +111686,329 @@ "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, - {}, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "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 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 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" - } - ], - "type": "list" + "description": "The external id of the network", + "name": "externalid", + "type": "string" }, { - "description": "the name of the network", - "name": "name", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "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", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the owner of the network", + "name": "account", + "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the type of the network", + "name": "type", + "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service 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": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "the name of the Network associated with this private gateway", + "description": "the name of the Network associated with this network", "name": "associatednetwork", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "state of the network", - "name": "state", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the owner of the network", - "name": "account", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "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": "The external id of the network", - "name": "externalid", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, - {} + { + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + } ] }, { @@ -111309,18 +112026,6 @@ } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -111330,6 +112035,18 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "3.0.0" @@ -111340,132 +112057,147 @@ "name": "addTungstenFabricPolicyRule", "params": [ { - "description": "Tungsten-Fabric policy rule source ip prefix length", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "srcipprefixlen", + "name": "policyuuid", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination end port", + "description": "Tungsten-Fabric policy rule destination ip prefix", "length": 255, - "name": "destendport", + "name": "destipprefix", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule source end port", + "description": "Tungsten-Fabric policy rule protocol", "length": 255, - "name": "srcendport", + "name": "protocol", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule source ip prefix", + "description": "Tungsten-Fabric policy rule source start port", "length": 255, - "name": "srcipprefix", + "name": "srcstartport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule action", + "description": "Tungsten-Fabric policy rule destination start port", "length": 255, - "name": "action", + "name": "deststartport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule destination start port", + "description": "Tungsten-Fabric policy rule source end port", "length": 255, - "name": "deststartport", + "name": "srcendport", "required": true, "type": "integer" }, { - "description": "Tungsten-Fabric policy rule source network", + "description": "the ID of zone", "length": 255, - "name": "srcnetwork", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Tungsten-Fabric policy rule source start port", + "description": "Tungsten-Fabric policy rule source ip prefix length", "length": 255, - "name": "srcstartport", + "name": "srcipprefixlen", "required": true, "type": "integer" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric policy rule destination ip prefix length", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "destipprefixlen", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule direction", + "description": "Tungsten-Fabric policy rule action", "length": 255, - "name": "direction", + "name": "action", "required": true, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "Tungsten-Fabric policy rule destination network", "length": 255, - "name": "policyuuid", + "name": "destnetwork", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix length", + "description": "Tungsten-Fabric policy rule source network", "length": 255, - "name": "destipprefixlen", + "name": "srcnetwork", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule protocol", + "description": "Tungsten-Fabric policy rule destination end port", "length": 255, - "name": "protocol", + "name": "destendport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule destination network", + "description": "Tungsten-Fabric policy rule source ip prefix", "length": 255, - "name": "destnetwork", + "name": "srcipprefix", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix", + "description": "Tungsten-Fabric policy rule direction", "length": 255, - "name": "destipprefix", + "name": "direction", "required": true, "type": "string" } ], "related": "", "response": [ + { + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", + "type": "int" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, { "description": "Tungsten-Fabric policy action", "name": "action", "type": "string" }, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", - "type": "string" + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" }, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", "type": "int" }, { - "description": "Tungsten-Fabric policy source ip prefix", - "name": "srcipprefix", + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", "type": "string" }, { @@ -111474,41 +112206,29 @@ "type": "int" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", "type": "int" }, - {}, { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "Tungsten-Fabric policy destination network", "name": "destnetwork", "type": "string" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", - "type": "int" + "description": "Tungsten-Fabric policy name", + "name": "direction", + "type": "string" }, { "description": "Tungsten-Fabric policy source network", @@ -111516,13 +112236,13 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", "type": "string" }, { - "description": "Tungsten-Fabric rule uuid", - "name": "uuid", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", "type": "string" }, { @@ -111530,21 +112250,18 @@ "name": "destipprefix", "type": "string" }, + {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", "type": "int" }, - { - "description": "Tungsten-Fabric policy name", - "name": "direction", - "type": "string" - } + {} ] }, { @@ -111552,14 +112269,6 @@ "isasync": true, "name": "dedicateHost", "params": [ - { - "description": "the ID of the host to update", - "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - }, { "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, @@ -111567,6 +112276,14 @@ "required": false, "type": "string" }, + { + "description": "the ID of the host to update", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,reconnectHost", + "required": true, + "type": "uuid" + }, { "description": "the ID of the containing domain", "length": 255, @@ -111579,45 +112296,45 @@ "related": "listDedicatedHosts", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain ID of the host", - "name": "domainid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, - {}, - {}, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the domain ID of the host", + "name": "domainid", "type": "string" }, + {}, { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the host", + "name": "hostname", "type": "string" } ] @@ -111628,11 +112345,12 @@ "name": "removeVpnUser", "params": [ { - "description": "an optional account for the vpn user. Must be used with domainId.", + "description": "remove vpn user from the project", "length": 255, - "name": "account", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "username for the vpn user", @@ -111650,12 +112368,11 @@ "type": "uuid" }, { - "description": "remove vpn user from the project", + "description": "an optional account for the vpn user. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "response": [ @@ -111664,12 +112381,12 @@ "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", @@ -111677,9 +112394,9 @@ }, {}, { - "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" } ] }, @@ -111695,13 +112412,6 @@ "required": true, "type": "string" }, - { - "description": "Password for GloboDNS", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, { "description": "the Physical Network ID", "length": 255, @@ -111710,6 +112420,13 @@ "required": true, "type": "uuid" }, + { + "description": "Password for GloboDNS", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, { "description": "GloboDNS url", "length": 255, @@ -111719,28 +112436,28 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting 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.5.0" }, @@ -111763,13 +112480,6 @@ "required": false, "type": "integer" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "Show IPs that are no longer in quarantine.", "length": 255, @@ -111783,19 +112493,26 @@ "name": "showremoved", "required": false, "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "updateQuarantinedIp", "response": [ - {}, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "ID of the quarantine process.", + "name": "id", "type": "string" }, + {}, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, { @@ -111803,47 +112520,47 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "The public IP address in quarantine.", - "name": "ipaddress", - "type": "string" - }, { "description": "Account name of the previous public IP address owner.", "name": "previousownername", "type": "string" }, { - "description": "When the quarantine was created.", - "name": "created", + "description": "When the quarantine was removed.", + "name": "removed", "type": "date" }, { - "description": "When the quarantine was removed.", - "name": "removed", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", + "type": "string" + }, + { + "description": "End date for the quarantine.", + "name": "enddate", "type": "date" }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, { - "description": "ID of the quarantine process.", - "name": "id", + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { - "description": "End date for the quarantine.", - "name": "enddate", + "description": "When the quarantine was created.", + "name": "created", "type": "date" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ], "since": "4.19" }, @@ -111854,23 +112571,23 @@ "params": [], "related": "", "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "Response description", + "name": "description", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "Response description", - "name": "description", - "type": "string" - } + {} ] }, { @@ -111888,28 +112605,28 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + {}, + {}, + { + "description": "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.2.0" }, @@ -111918,13 +112635,6 @@ "isasync": false, "name": "importRole", "params": [ - { - "description": "Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, { "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, @@ -111939,6 +112649,13 @@ "required": false, "type": "boolean" }, + { + "description": "Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, { "description": "The description of the role", "length": 255, @@ -111947,18 +112664,18 @@ "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": "Creates a role with this unique name", "length": 255, - "name": "rules", + "name": "name", "required": true, - "type": "map" + "type": "string" }, { - "description": "Creates a role with this unique name", + "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": "name", + "name": "rules", "required": true, - "type": "string" + "type": "map" } ], "related": "", @@ -111969,30 +112686,29 @@ "type": "boolean" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "the ID of the role", "name": "id", "type": "string" }, { - "description": "the type of the role", - "name": "type", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "the description of the role", - "name": "description", - "type": "string" - }, + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" + }, { - "description": "the name of the role", - "name": "name", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of the role", + "name": "type", "type": "string" }, { @@ -112001,10 +112717,11 @@ "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" - } + "description": "the description of the role", + "name": "description", + "type": "string" + }, + {} ], "since": "4.15.0" }, @@ -112013,13 +112730,6 @@ "isasync": false, "name": "listSwifts", "params": [ - { - "description": "the id of the swift", - "length": 255, - "name": "id", - "required": false, - "type": "long" - }, { "description": "", "length": 255, @@ -112040,82 +112750,89 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "the id of the swift", + "length": 255, + "name": "id", + "required": false, + "type": "long" } ], "related": "addImageStoreS3,listImageStores", "response": [ { - "description": "the ID of the image store", - "name": "id", - "type": "string" - }, - { - "description": "the url of the image store", - "name": "url", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, - {}, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, { "description": "the 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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, { "description": "the 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": "defines if store is read-only", - "name": "readonly", + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, { "description": "the name of the image store", "name": "name", "type": "string" }, - { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - } + {} ], "since": "3.0.0" }, @@ -112128,28 +112845,27 @@ "description": "ID of the host", "length": 255, "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": true, "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" + "description": "operation status", + "name": "status", + "type": "boolean" }, { "description": "the ID of the host", @@ -112157,21 +112873,22 @@ "type": "string" }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "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", + "description": "the host HA provider", + "name": "haprovider", "type": "string" - } + }, + {} ], "since": "4.11" }, @@ -112184,7 +112901,7 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": true, "type": "uuid" } @@ -112197,8 +112914,13 @@ "type": "powerstate" }, { - "description": "the operation result description", - "name": "description", + "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" }, {}, @@ -112208,35 +112930,30 @@ "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - {}, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the operation result description", + "name": "description", + "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, + {}, { - "description": "the 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 driver for the host", - "name": "driver", + "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": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { "description": "the out-of-band management interface username", @@ -112244,18 +112961,18 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" } ], @@ -112281,12 +112998,6 @@ "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", @@ -112297,7 +113008,13 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ] }, { @@ -112306,83 +113023,99 @@ "name": "listKubernetesSupportedVersions", "params": [ { - "description": "the minimum semantic version for the Kubernetes supported version to be listed", + "description": "List by keyword", "length": 255, - "name": "minimumsemanticversion", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "the ID of the minimum Kubernetes supported version", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "minimumkubernetesversionid", + "related": "listKubernetesSupportedVersions", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the Kubernetes supported version", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "id", - "related": "listKubernetesSupportedVersions", + "name": "zoneid", + "related": "createZone,listZones", "required": false, "type": "uuid" }, { - "description": "the ID of the minimum Kubernetes supported version", + "description": "the minimum semantic version for the Kubernetes supported version to be listed", "length": 255, - "name": "minimumkubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "minimumsemanticversion", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the ID of the Kubernetes supported version", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listKubernetesSupportedVersions", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, + {}, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "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": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" + }, + { + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { @@ -112391,13 +113124,14 @@ "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, + {}, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { @@ -112406,48 +113140,91 @@ "type": "boolean" }, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "Name of the Kubernetes supported version", + "name": "name", + "type": "string" }, - {}, - {}, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "the id of the Kubernetes supported version", + "name": "id", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + } + ] + }, + { + "description": "Updates existing email templates for quota alerts", + "isasync": false, + "name": "quotaEmailTemplateUpdate", + "params": [ + { + "description": "The quota email template subject, max: 77 characters", + "length": 77, + "name": "templatesubject", + "required": true, + "type": "string" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "The locale of the email text", + "length": 255, + "name": "locale", + "required": false, "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", + "length": 255, + "name": "templatetype", + "required": true, + "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", + "description": "The quota email template body, max: 500k characters", + "length": 512000, + "name": "templatebody", + "required": true, + "type": "string" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "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.7.0" }, { "description": "Adds a Nicira NVP device", @@ -112455,17 +113232,17 @@ "name": "addNiciraNvpDevice", "params": [ { - "description": "Hostname of ip address of the Nicira NVP Controller.", + "description": "The Transportzone UUID configured on the Nicira Controller", "length": 255, - "name": "hostname", + "name": "transportzoneuuid", "required": true, "type": "string" }, { - "description": "The Transportzone UUID configured on the Nicira Controller", + "description": "The L2 Gateway Service UUID configured on the Nicira Controller", "length": 255, - "name": "transportzoneuuid", - "required": true, + "name": "l2gatewayserviceuuid", + "required": false, "type": "string" }, { @@ -112476,18 +113253,10 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "Hostname of ip address of the Nicira NVP Controller.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "hostname", "required": true, - "type": "uuid" - }, - { - "description": "The L2 Gateway Service UUID configured on the Nicira Controller", - "length": 255, - "name": "l2gatewayserviceuuid", - "required": false, "type": "string" }, { @@ -112503,45 +113272,53 @@ "name": "l3gatewayserviceuuid", "required": false, "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" } ], "related": "", "response": [ + {}, + {}, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" }, { - "description": "device name", - "name": "niciradevicename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, { @@ -112550,14 +113327,14 @@ "type": "string" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "device name", + "name": "niciradevicename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the controller Ip address", + "name": "hostname", + "type": "string" } ] }, @@ -112566,31 +113343,38 @@ "isasync": false, "name": "listNetworkServiceProviders", "params": [ + { + "description": "list providers by state", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "list providers by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "list providers by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -112601,40 +113385,33 @@ "related": "createPhysicalNetwork", "required": false, "type": "uuid" - }, - { - "description": "list providers by state", - "length": 255, - "name": "state", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "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": "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "state of the network provider", + "name": "state", + "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -112643,20 +113420,20 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "services for this provider", "name": "servicelist", "type": "list" }, - {}, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, {} ], @@ -112684,27 +113461,27 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -112716,70 +113493,65 @@ "related": "", "response": [ { - "description": "Number of object stores", - "name": "objectstores", + "description": "Number of Alerts", + "name": "alerts", "type": "integer" }, - {}, { - "description": "Number of clusters", - "name": "clusters", + "description": "Number of internal LBs", + "name": "ilbvms", "type": "integer" }, { - "description": "Number of cpu sockets", - "name": "cpusockets", + "description": "Number of images stores", + "name": "imagestores", "type": "integer" }, { - "description": "Number of hypervisor hosts", - "name": "hosts", + "description": "Number of pods", + "name": "pods", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Number of clusters", + "name": "clusters", "type": "integer" }, { - "description": "Number of images stores", - "name": "imagestores", + "description": "Number of cpu sockets", + "name": "cpusockets", "type": "integer" }, { - "description": "Number of storage pools", - "name": "storagepools", + "description": "Number of management servers", + "name": "managementservers", "type": "integer" }, + {}, + {}, { - "description": "Number of Alerts", - "name": "alerts", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - {}, { - "description": "Number of management servers", - "name": "managementservers", + "description": "Number of zones", + "name": "zones", "type": "integer" }, { - "description": "Number of internal LBs", - "name": "ilbvms", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Number of routers", - "name": "routers", + "description": "Number of storage pools", + "name": "storagepools", "type": "integer" }, { - "description": "Number of zones", - "name": "zones", + "description": "Number of hypervisor hosts", + "name": "hosts", "type": "integer" }, { @@ -112788,8 +113560,13 @@ "type": "integer" }, { - "description": "Number of pods", - "name": "pods", + "description": "Number of routers", + "name": "routers", + "type": "integer" + }, + { + "description": "Number of object stores", + "name": "objectstores", "type": "integer" } ], @@ -112801,11 +113578,11 @@ "name": "listUsageRecords", "params": [ { - "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", + "description": "List by keyword", "length": 255, - "name": "oldformat", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", @@ -112814,6 +113591,20 @@ "required": false, "type": "string" }, + { + "description": "End date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00).", + "length": 255, + "name": "enddate", + "required": true, + "type": "date" + }, + { + "description": "List usage records for the specified usage type", + "length": 255, + "name": "type", + "required": false, + "type": "long" + }, { "description": "Start date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00).", "length": 255, @@ -112830,155 +113621,111 @@ "type": "uuid" }, { - "description": "List usage records for the specified user.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List usage records for the specified usage type", + "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", "length": 255, - "name": "type", + "name": "oldformat", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "List usage records for the specified domain.", + "description": "List usage records for the specified account", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "accountid", + "related": "enableAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, { - "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", + "description": "Flag to enable display of Tags for a resource", "length": 255, - "name": "isrecursive", + "name": "includetags", "required": false, - "since": "4.15", "type": "boolean" }, { - "description": "Flag to enable display of Tags for a resource", + "description": "List usage records for the specified domain.", "length": 255, - "name": "includetags", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List usage records for the specified account", + "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": "accountid", - "related": "enableAccount,listAccounts,listAccounts", + "name": "isrecursive", "required": false, - "type": "uuid" + "since": "4.15", + "type": "boolean" }, { - "description": "List by keyword", + "description": "List usage records for the specified user.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" - }, - { - "description": "End date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00).", - "length": 255, - "name": "enddate", - "required": true, - "type": "date" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "", "response": [ { - "description": "memory allocated for the resource", - "name": "memory", - "type": "long" - }, - { - "description": "usage type ID", - "name": "usagetype", - "type": "integer" - }, - { - "description": "end date of the usage record", - "name": "enddate", + "description": "virtual machine os category name", + "name": "oscategoryname", "type": "string" }, - {}, { - "description": "start date of the usage record", - "name": "startdate", - "type": "string" + "description": "speed of each cpu of resource", + "name": "cpuspeed", + "type": "long" }, { - "description": "the user account name", - "name": "account", + "description": "raw usage in hours", + "name": "rawusage", "type": "string" }, { - "description": "virtual size of resource", - "name": "virtualsize", + "description": "memory allocated for the resource", + "name": "memory", "type": "long" }, { - "description": "the zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "virtual machine ID", - "name": "virtualmachineid", + "description": "virtual machine os type ID", + "name": "ostypeid", "type": "string" }, + {}, { "description": "template ID", "name": "templateid", "type": "string" }, { - "description": "the domain ID", - "name": "domainid", - "type": "string" - }, - { - "description": "usage in hours", - "name": "usage", - "type": "string" - }, - { - "description": "the project name of the resource", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "virtual machine os category name", - "name": "oscategoryname", - "type": "string" + "description": "usage type ID", + "name": "usagetype", + "type": "integer" }, { - "description": "virtual machine os type ID", - "name": "ostypeid", + "description": "the project id of the resource", + "name": "projectid", "type": "string" }, { @@ -112987,24 +113734,14 @@ "type": "boolean" }, { - "description": "the project id of the resource", - "name": "projectid", - "type": "string" - }, - { - "description": "number of cpu of resource", - "name": "cpunumber", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the vpc", + "name": "vpcid", "type": "string" }, { - "description": "speed of each cpu of resource", - "name": "cpuspeed", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the user account Id", @@ -113012,20 +113749,19 @@ "type": "string" }, { - "description": "virtual machine guest os category ID", - "name": "oscategoryid", + "description": "usage in hours", + "name": "usage", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID", + "name": "domainid", + "type": "string" }, - {}, { - "description": "description of the usage record", - "name": "description", - "type": "string" + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", + "type": "boolean" }, { "description": "true if the entity/resource has annotations", @@ -113033,14 +113769,19 @@ "type": "boolean" }, { - "description": "raw usage in hours", - "name": "rawusage", + "description": "the zone ID", + "name": "zoneid", "type": "string" }, { - "description": "True if the resource is default", - "name": "isdefault", - "type": "boolean" + "description": "virtual machine guest os category ID", + "name": "oscategoryid", + "type": "string" + }, + { + "description": "description of the usage record", + "name": "description", + "type": "string" }, { "description": "resource size", @@ -113048,43 +113789,43 @@ "type": "long" }, { - "description": "id of the resource", - "name": "usageid", + "description": "the domain the resource is associated with", + "name": "domain", "type": "string" }, { - "description": "id of the network", - "name": "networkid", + "description": "the project name of the resource", + "name": "project", "type": "string" }, { - "description": "id of the vpc", - "name": "vpcid", - "type": "string" + "description": "True if the resource is default", + "name": "isdefault", + "type": "boolean" }, { - "description": "the domain the resource is associated with", - "name": "domain", + "description": "the user account name", + "name": "account", "type": "string" }, { - "description": "resource or virtual machine name", - "name": "name", + "description": "offering ID", + "name": "offeringid", "type": "string" }, { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", - "type": "boolean" + "description": "id of the resource", + "name": "usageid", + "type": "string" }, { - "description": "offering ID", - "name": "offeringid", + "description": "resource type", + "name": "type", "type": "string" }, { - "description": "virtual machine os display name", - "name": "osdisplayname", + "description": "virtual machine ID", + "name": "virtualmachineid", "type": "string" }, { @@ -113092,8 +113833,13 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -113102,18 +113848,18 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -113122,27 +113868,58 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" + }, + { + "description": "virtual size of resource", + "name": "virtualsize", + "type": "long" + }, + { + "description": "start date of the usage record", + "name": "startdate", + "type": "string" + }, + {}, + { + "description": "resource or virtual machine name", + "name": "name", + "type": "string" + }, + { + "description": "virtual machine os display name", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "end date of the usage record", + "name": "enddate", + "type": "string" + }, + { + "description": "id of the network", + "name": "networkid", + "type": "string" + }, + { + "description": "number of cpu of resource", + "name": "cpunumber", + "type": "long" } ] }, @@ -113161,28 +113938,28 @@ } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ], "since": "4.19.0" }, @@ -113201,17 +113978,6 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -113222,7 +113988,18 @@ "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" + } ] }, { @@ -113240,27 +114017,27 @@ } ], "response": [ - {}, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "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" } ] }, @@ -113281,84 +114058,121 @@ "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "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 date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { "description": "the state of the disk volume", @@ -113366,18 +114180,18 @@ "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { @@ -113386,292 +114200,255 @@ "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, + {}, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "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": "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": "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 id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { "description": "the display text of the service offering for root disk", "name": "serviceofferingdisplaytext", "type": "string" }, + {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, { "description": "pod name of the volume", "name": "podname", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", - "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": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, - {}, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the path of the volume", + "name": "path", "type": "string" }, - {}, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" } ], @@ -113682,13 +114459,6 @@ "isasync": true, "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "params": [ - { - "description": "Tungsten-Fabric network uuid", - "length": 255, - "name": "networkuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -113703,30 +114473,27 @@ "name": "logicalrouteruuid", "required": true, "type": "string" + }, + { + "description": "Tungsten-Fabric network uuid", + "length": 255, + "name": "networkuuid", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "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", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -113739,11 +114506,21 @@ "type": "long" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "Tungsten-Fabric logical router name", + "name": "name", + "type": "string" + } ] }, { @@ -113769,58 +114546,58 @@ ], "related": "removeSecondaryStorageSelector", "response": [ + { + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "When the heuristic was created.", "name": "created", "type": "date" }, - { - "description": "Description of the heuristic.", - "name": "description", - "type": "string" - }, { "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", "name": "heuristicrule", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", + "type": "string" }, { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" + "description": "Description of the heuristic.", + "name": "description", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "ID of the heuristic.", - "name": "id", - "type": "string" - }, { "description": "Name of the heuristic.", "name": "name", "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", - "type": "string" + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, - {}, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", + "description": "ID of the heuristic.", + "name": "id", "type": "string" - } + }, + {} ], "since": "4.19.0" }, @@ -113841,74 +114618,70 @@ "related": "createUser,getUser", "response": [ { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the user state", - "name": "state", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the ID of the role", "name": "roleid", "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": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, {}, { - "description": "the api key of the user", - "name": "apikey", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user name", + "name": "username", "type": "string" }, { @@ -113917,59 +114690,63 @@ "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "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": "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 user email address", - "name": "email", + "description": "the user firstname", + "name": "firstname", "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 boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, - {}, { - "description": "the user lastname", - "name": "lastname", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user lastname", + "name": "lastname", "type": "string" } ] @@ -113980,27 +114757,28 @@ "name": "listZonesMetrics", "params": [ { - "description": "the IDs of the zones, mutually exclusive with id", + "description": "the network type of the zone that the virtual machine belongs to", "length": 255, - "name": "ids", - "related": "createZone,listZones", + "name": "networktype", "required": false, - "since": "4.19.0", - "type": "list" + "type": "string" }, { - "description": "", + "description": "List zones by resource tags (key/value pairs)", "length": 255, - "name": "page", + "name": "tags", "required": false, - "type": "integer" + "since": "4.3", + "type": "map" }, { - "description": "", + "description": "the IDs of the zones, mutually exclusive with id", "length": 255, - "name": "pagesize", + "name": "ids", + "related": "createZone,listZones", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "list" }, { "description": "the ID of the zone", @@ -114011,23 +114789,30 @@ "type": "uuid" }, { - "description": "flag to display the resource image for the zones", + "description": "the name of the zone", "length": 255, - "name": "showicon", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "flag to display the capacity of the zones", + "length": 255, + "name": "showcapacities", "required": false, "type": "boolean" }, { - "description": "the network type of the zone that the virtual machine belongs to", + "description": "", "length": 255, - "name": "networktype", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", + "description": "flag to display the resource image for the zones", "length": 255, - "name": "available", + "name": "showicon", "required": false, "type": "boolean" }, @@ -114039,86 +114824,53 @@ "type": "string" }, { - "description": "the ID of the domain associated with the zone", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "tags", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.3", - "type": "map" + "type": "uuid" }, { - "description": "flag to display the capacity of the zones", + "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": "showcapacities", + "name": "available", "required": false, "type": "boolean" - }, - { - "description": "the name of the zone", - "length": 255, - "name": "name", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", - "type": "string" - }, - { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the total cpu used in GiB", + "name": "memoryused", "type": "string" }, { @@ -114127,59 +114879,24 @@ "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", - "type": "string" - }, - { - "description": "the type of the zone - core or edge", - "name": "type", - "type": "string" - }, - { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", "type": "integer" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", - "type": "string" - }, - { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - }, - { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" - }, - { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "the total cpu used in Ghz", + "name": "cpuused", "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "Zone id", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "cpu allocated disable threshold exceeded", @@ -114187,18 +114904,13 @@ "type": "boolean" }, { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" - }, - { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -114208,218 +114920,152 @@ "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", - "type": "string" - }, - { - "description": "Network domain name for the networks in the zone", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "healthy / total clusters in the zone", - "name": "clusters", - "type": "string" - }, - { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", - "type": "string" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" - }, - { - "description": "the list of resource tags associated with zone.", - "name": "tags", + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" } ], - "type": "set" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" + "type": "list" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the Pod ID", - "name": "podid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Zone name", - "name": "zonename", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "list" - }, - { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "type": "set" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" - }, - { - "description": "Zone description", - "name": "description", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { @@ -114428,561 +115074,500 @@ "type": "boolean" }, { - "description": "state of the cluster", - "name": "state", - "type": "string" - } - ], - "since": "4.9.3" - }, - { - "description": "Extracts a template", - "isasync": true, - "name": "extractTemplate", - "params": [ - { - "description": "the ID of the zone where the ISO is originally located", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, { - "description": "the ID of the template", - "length": 255, - "name": "id", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", - "length": 255, - "name": "mode", - "required": true, + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "the url to which the ISO would be extracted", - "length": 2048, - "name": "url", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the name of the extracted object", + "description": "Zone name", "name": "name", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the display text of the zone", + "name": "displaytext", "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 maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, - {}, { - "description": "the id of extracted object", - "name": "id", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, - {}, { - "description": "the status of the extraction", - "name": "status", - "type": "string" + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" }, { - "description": "type of the storage", - "name": "storagetype", - "type": "string" + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "the state of the extracted object", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" + }, + { + "description": "state of the cluster", "name": "state", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" - } - ] - }, - { - "description": "Expunge a virtual machine. Once expunged, it cannot be recoverd.", - "isasync": true, - "name": "expungeVirtualMachine", - "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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "healthy / total clusters in the zone", + "name": "clusters", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" + }, + { + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" } - ] + ], + "since": "4.9.3" }, { - "description": "Suspends a project", - "isasync": true, - "name": "suspendProject", + "description": "Creates a quota tariff for a resource.", + "isasync": false, + "name": "quotaTariffCreate", "params": [ { - "description": "id of the project to be suspended", - "length": 255, - "name": "id", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" - } - ], - "related": "activateProject", - "response": [ - { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied.", + "length": 65535, + "name": "activationrule", + "required": false, "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" + "description": "Integer value for the usage type of the resource.", + "length": 255, + "name": "usagetype", + "required": true, + "type": "integer" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "Quota tariff's description.", + "length": 65535, + "name": "description", + "required": false, "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "Quota tariff's name", + "length": 65535, + "name": "name", + "required": true, "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "The quota tariff value of the resource as per the default unit.", + "length": 255, + "name": "value", + "required": true, + "type": "double" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" + "description": "The end date of the quota tariff. Use yyyy-MM-dd as the date format, e.g. endDate=2009-06-03.", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" - }, + "description": "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. Inform null to use the current date.", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + } + ], + "related": "", + "response": [ { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" + "description": "usageType", + "name": "usageType", + "type": "int" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "usageName", + "name": "usageName", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "currency", + "name": "currency", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "name", + "name": "name", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "activation rule of the quota tariff", + "name": "activationRule", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "usageUnit", + "name": "usageUnit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "usageDiscriminator", + "name": "usageDiscriminator", "type": "string" }, { - "description": "the state of the project", - "name": "state", - "type": "string" + "description": "the start date of the quota tariff", + "name": "effectiveDate", + "type": "date" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "description", + "name": "description", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "usage type description", + "name": "usageTypeDescription", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the name of the project", - "name": "name", + "description": "uuid", + "name": "uuid", "type": "string" }, + {}, + {} + ], + "since": "4.18.0.0" + }, + { + "description": "Extracts a template", + "isasync": true, + "name": "extractTemplate", + "params": [ { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the url to which the ISO would be extracted", + "length": 2048, + "name": "url", + "required": false, "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the ID of the zone where the ISO is originally located", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - {}, - {}, + "description": "the ID of the template", + "length": 255, + "name": "id", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "", + "name": "resultstring", "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 date this project was created", + "description": "the time and date the object was created", "name": "created", "type": "date" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the status of the extraction", + "name": "status", + "type": "string" }, + {}, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" + "description": "type of the storage", + "name": "storagetype", + "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, + {}, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", "type": "integer" + }, + { + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Updates an IP address", + "description": "Expunge a virtual machine. Once expunged, it cannot be recoverd.", "isasync": true, - "name": "updateIpAddress", + "name": "expungeVirtualMachine", "params": [ { - "description": "an optional field, whether to the display the IP to the end user or not", + "description": "The ID of the virtual machine", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "name": "id", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "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 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 ID of the public IP address to update", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {} + ] + }, + { + "description": "Suspends a project", + "isasync": true, + "name": "suspendProject", + "params": [ + { + "description": "id of the project to be suspended", "length": 255, "name": "id", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "activateProject,suspendProject", "required": true, "type": "uuid" } ], - "related": "associateIpAddress,listPublicIpAddresses", + "related": "activateProject", "response": [ { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "the list of resource tags associated with ip address", + "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { @@ -114991,18 +115576,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -115011,13 +115591,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -115025,388 +115605,404 @@ "name": "domainid", "type": "string" }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the project name of the address", - "name": "project", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", - "type": "string" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, - {}, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "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 total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "public IP address id", - "name": "id", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, - {}, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "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 account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" - }, - { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" - } - ] - }, - { - "description": "Get API limit count for the caller", - "isasync": false, - "name": "getApiLimit", - "params": [], - "related": "", - "response": [ + }, { - "description": "the account uuid of the api remaining count", - "name": "accountid", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "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 project", + "name": "vmstopped", "type": "integer" }, - {}, { - "description": "number of api already issued", - "name": "apiIssued", - "type": "int" + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" }, - {}, { - "description": "currently allowed number of apis", - "name": "apiAllowed", - "type": "int" + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the account name of the api remaining count", - "name": "account", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "seconds left to reset counters", - "name": "expireAfter", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", "type": "long" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ] - }, - { - "description": "Deletes a storage network IP Range.", - "isasync": true, - "name": "deleteStorageNetworkIpRange", - "params": [ + }, { - "description": "the uuid of the storage network ip range", - "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the state of the project", + "name": "state", + "type": "string" } ], "since": "3.0.0" }, { - "description": "moves a network to another physical network", + "description": "Updates an IP address", "isasync": true, - "name": "migrateNetwork", + "name": "updateIpAddress", "params": [ { - "description": "the ID of the network", + "description": "the ID of the public IP address to update", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "id", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, "type": "uuid" }, { - "description": "network offering ID", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "networkofferingid", - "related": "", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "true if previous network migration cmd failed", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "resume", + "name": "customid", "required": false, - "type": "boolean" + "since": "4.4", + "type": "string" } ], - "related": "createNetwork,updateNetwork,listNetworks", + "related": "associateIpAddress,listPublicIpAddresses", "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 ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if network is system, false otherwise", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", "name": "issystem", "type": "boolean" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, + {}, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, + { + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", + "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", "type": "boolean" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "is public ip for display to the regular user", + "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", + "description": "the ID of the Network associated with the IP address", "name": "associatednetworkid", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of resource tags associated with ip address", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -115415,190 +116011,405 @@ "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "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": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" + }, + { + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Name of the VPC to which this network belongs", + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + {}, + { + "description": "VPC name the ip belongs to", "name": "vpcname", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" + } + ] + }, + { + "description": "Get API limit count for the caller", + "isasync": false, + "name": "getApiLimit", + "params": [], + "related": "", + "response": [ + { + "description": "number of api already issued", + "name": "apiIssued", + "type": "int" + }, + { + "description": "the account uuid of the api remaining count", + "name": "accountid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the account name of the api remaining count", + "name": "account", "type": "string" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "seconds left to reset counters", + "name": "expireAfter", "type": "long" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "currently allowed number of apis", + "name": "apiAllowed", + "type": "int" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Deletes a storage network IP Range.", + "isasync": true, + "name": "deleteStorageNetworkIpRange", + "params": [ + { + "description": "the uuid of the storage network ip range", + "length": 255, + "name": "id", + "related": "createStorageNetworkIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} + ], + "since": "3.0.0" + }, + { + "description": "moves a network to another physical network", + "isasync": true, + "name": "migrateNetwork", + "params": [ + { + "description": "network offering ID", + "length": 255, + "name": "networkofferingid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "true if previous network migration cmd failed", + "length": 255, + "name": "resume", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": true, + "type": "uuid" + } + ], + "related": "createNetwork,updateNetwork,listNetworks", + "response": [ { "description": "the traffic type of the network", "name": "traffictype", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "the id of the network", + "name": "id", + "type": "string" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" + }, + {}, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", "type": "integer" }, + { + "description": "the list of resource tags associated with network", + "name": "tags", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, { "description": "network offering id the network is created from", "name": "networkofferingid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "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 network", - "name": "id", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the name of the network", - "name": "name", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { "description": "the list of services", "name": "service", "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, { "description": "the service name", "name": "name", @@ -115609,8 +116420,18 @@ "name": "provider", "response": [ { - "description": "uuid of the network provider", - "name": "id", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -115618,30 +116439,42 @@ "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" - }, + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ { - "description": "state of the network provider", - "name": "state", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the capability name", + "name": "name", + "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], "type": "list" @@ -115650,14 +116483,44 @@ "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" }, { "description": "true if network offering is ip conserve mode enabled", @@ -115665,108 +116528,149 @@ "type": "boolean" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "the type of the network", + "name": "type", "type": "string" }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "The routing mode of network offering", "name": "ip6routing", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, + {}, { - "description": "the project name of the address", - "name": "project", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { @@ -115775,28 +116679,43 @@ "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" } ], @@ -115807,6 +116726,13 @@ "isasync": false, "name": "addVmwareDc", "params": [ + { + "description": "Name of VMware datacenter to be added to specified zone.", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "The Zone ID.", "length": 255, @@ -115816,10 +116742,10 @@ "type": "uuid" }, { - "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "The Username required to connect to resource.", "length": 255, - "name": "vcenter", - "required": true, + "name": "username", + "required": false, "type": "string" }, { @@ -115830,53 +116756,46 @@ "type": "string" }, { - "description": "Name of VMware datacenter to be added to specified zone.", + "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", "length": 255, - "name": "name", + "name": "vcenter", "required": true, "type": "string" - }, - { - "description": "The Username required to connect to resource.", - "length": 255, - "name": "username", - "required": false, - "type": "string" } ], "related": "", "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" }, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, { - "description": "The VMware Datacenter name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" }, { - "description": "the 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" } ] }, @@ -115886,18 +116805,27 @@ "name": "updateIpv6FirewallRule", "params": [ { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "cidrlist", + "name": "customid", "required": false, - "type": "list" + "since": "4.4", + "type": "string" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "the ID of the ipv6 firewall rule", "length": 255, - "name": "startport", + "name": "id", + "related": "updateIpv6FirewallRule", + "required": true, + "type": "uuid" + }, + { + "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": "integer" + "type": "list" }, { "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", @@ -115908,21 +116836,12 @@ "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "customid", + "name": "traffictype", "required": false, - "since": "4.4", "type": "string" }, - { - "description": "the ID of the ipv6 firewall rule", - "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule", - "required": true, - "type": "uuid" - }, { "description": "the ending port of Ipv6 firewall rule", "length": 255, @@ -115931,51 +116850,41 @@ "type": "integer" }, { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "type of the ICMP message being sent", "length": 255, - "name": "protocol", + "name": "icmptype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "error code for this ICMP message", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "icmpcode", + "name": "startport", "required": false, "type": "integer" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "error code for this ICMP message", "length": 255, - "name": "traffictype", + "name": "icmpcode", "required": false, - "type": "string" + "type": "integer" }, { - "description": "type of the ICMP message being sent", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "icmptype", + "name": "protocol", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -115986,38 +116895,38 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -116026,89 +116935,99 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "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 public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, + {}, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the 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", + "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ] }, @@ -116117,6 +117036,13 @@ "isasync": false, "name": "listUnmanagedInstances", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "the hypervisor name of the instance", "length": 255, @@ -116125,11 +117051,12 @@ "type": "string" }, { - "description": "", + "description": "the cluster ID", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" }, { "description": "", @@ -116144,137 +117071,112 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" } ], "related": "", "response": [ { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", "type": "integer" }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the power state of the virtual machine", + "name": "powerstate", + "type": "string" + }, + { + "description": "the list of nics associated with the virtual machine", + "name": "nic", "response": [ { - "description": "the file path of the disk image", - "name": "imagepath", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorepath", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the label of the disk", - "name": "label", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the disk", - "name": "id", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorename", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the position of the disk", - "name": "position", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of nics associated with the virtual machine", - "name": "nic", - "response": [ + }, { "description": "the netmask of the nic", "name": "netmask", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -116283,9 +117185,9 @@ "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { "description": "the gateway of the nic", @@ -116293,48 +117195,43 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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 ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the 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 name of the corresponding network", - "name": "networkname", + "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -116343,61 +117240,26 @@ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" } ], "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", + "type": "string" }, { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", "type": "integer" }, { @@ -116406,14 +117268,8 @@ "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", + "description": "the memory of the virtual machine in MB", + "name": "memory", "type": "integer" }, { @@ -116422,28 +117278,29 @@ "type": "string" }, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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": "the name of the cluster to which virtual machine belongs", - "name": "clustername", - "type": "string" + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" }, + {}, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "type": "string" }, { @@ -116451,7 +117308,69 @@ "name": "osid", "type": "string" }, - {} + {}, + { + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + }, + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + }, + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "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 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" + } + ], + "type": "set" + } ], "since": "4.14.0" }, @@ -116461,34 +117380,25 @@ "name": "updateIsoPermissions", "params": [ { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "description": "true for public template/iso, false for private templates/isos", "length": 255, - "name": "projectids", - "related": "activateProject", + "name": "ispublic", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "description": "true for featured template/iso, false otherwise", "length": 255, - "name": "isextractable", + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "the template ID", - "length": 255, - "name": "id", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - }, - { - "description": "true for featured template/iso, false otherwise", + "description": "permission operator (add, remove, reset)", "length": 255, - "name": "isfeatured", + "name": "op", "required": false, - "type": "boolean" + "type": "string" }, { "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", @@ -116498,22 +117408,36 @@ "type": "list" }, { - "description": "permission operator (add, remove, reset)", + "description": "the template ID", "length": 255, - "name": "op", - "required": false, - "type": "string" + "name": "id", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "true for public template/iso, false for private templates/isos", + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", "length": 255, - "name": "ispublic", + "name": "isextractable", "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" } ], "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", @@ -116525,11 +117449,6 @@ "type": "integer" }, {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -116543,26 +117462,11 @@ "name": "registerTemplate", "params": [ { - "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", - "length": 255, - "name": "zoneids", - "related": "createZone,listZones", - "required": false, - "type": "list" - }, - { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "32 or 64 bits support. 64 by default", + "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": "bits", + "name": "checksum", "required": false, - "type": "integer" + "type": "string" }, { "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", @@ -116573,32 +117477,33 @@ "type": "string" }, { - "description": "the name of the template", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "isextractable", + "required": false, + "type": "boolean" }, { - "description": "true if this template requires HVM", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "requireshvm", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "account", + "name": "bits", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, - "type": "string" + "description": "Register template for the project", + "length": 255, + "name": "projectid", + "related": "activateProject", + "required": false, + "type": "uuid" }, { "description": "the target hypervisor for the template", @@ -116608,71 +117513,69 @@ "type": "string" }, { - "description": "Register template for the project", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "ispublic", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", + "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": "isfeatured", + "name": "zoneids", + "related": "createZone,listZones", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the name of the template", "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "isrouting", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the zone the template is to be hosted on", + "description": "true if this template requires HVM", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "requireshvm", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "checksum", + "name": "account", "required": false, "type": "string" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "isextractable", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", - "length": 255, - "name": "deployasis", + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", "required": false, - "since": "4.15.1", - "type": "boolean" + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "isdynamicallyscalable", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", @@ -116683,11 +117586,11 @@ "type": "uuid" }, { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "length": 255, + "name": "directdownload", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the tag for this template.", @@ -116697,26 +117600,35 @@ "type": "string" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "directdownload", + "name": "deployasis", "required": false, + "since": "4.15.1", "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "isrouting", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "passwordenabled", + "name": "isfeatured", "required": false, "type": "boolean" }, + { + "description": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, + "type": "string" + }, { "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, @@ -116725,18 +117637,50 @@ "type": "string" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "ispublic", + "name": "passwordenabled", "required": false, "type": "boolean" + }, + { + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" } ], "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the template ID", - "name": "id", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { @@ -116745,177 +117689,123 @@ "type": "imageformat" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the template display text", + "name": "displaytext", "type": "string" }, - {}, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "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" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", "type": "set" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { @@ -116923,10 +117813,16 @@ "name": "deployasis", "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 created", + "name": "created", + "type": "date" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" }, { "description": "true if the template is extractable, false otherwise", @@ -116934,14 +117830,9 @@ "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { "description": "additional key/value details tied with template", @@ -116949,70 +117840,112 @@ "type": "map" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { - "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": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the account name to which the template belongs", - "name": "account", + "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 physical size of the template", "name": "physicalsize", @@ -117024,38 +117957,24 @@ "type": "string" }, { - "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": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "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": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", "name": "userdataparams", "type": "string" }, + {}, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template ID", + "name": "id", "type": "string" } ] @@ -117076,16 +117995,17 @@ ], "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + { + "description": "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", @@ -117095,8 +118015,7 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -117105,11 +118024,12 @@ "name": "addStratosphereSsp", "params": [ { - "description": "stratosphere ssp api username", + "description": "the zone ID", "length": 255, - "name": "username", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { "description": "stratosphere ssp tenant uuid", @@ -117119,19 +118039,18 @@ "type": "string" }, { - "description": "stratosphere ssp api password", + "description": "stratosphere ssp api name", "length": 255, - "name": "password", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the zone ID", + "description": "stratosphere ssp api username", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "name": "username", + "required": false, + "type": "string" }, { "description": "stratosphere ssp server url", @@ -117141,46 +118060,46 @@ "type": "string" }, { - "description": "stratosphere ssp api name", + "description": "stratosphere ssp api password", "length": 255, - "name": "name", - "required": true, + "name": "password", + "required": false, "type": "string" } ], "related": "", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "url of ssp endpoint", - "name": "url", - "type": "string" - }, { - "description": "zone which this ssp controls", - "name": "zoneid", + "description": "name", + "name": "name", "type": "string" }, + {}, { "description": "server id of the stratosphere ssp server", "name": "hostid", "type": "string" }, - { - "description": "name", - "name": "name", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "zone which this ssp controls", + "name": "zoneid", + "type": "string" + }, + { + "description": "url of ssp endpoint", + "name": "url", + "type": "string" } ] }, @@ -117199,23 +118118,23 @@ } ], "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", @@ -117229,54 +118148,48 @@ "name": "createStoragePool", "params": [ { - "description": "the tags for the storage pool", + "description": "IOPS CloudStack can provision from this storage pool", "length": 255, - "name": "tags", + "name": "capacityiops", "required": false, - "type": "string" - }, - { - "description": "the name for the storage pool", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "type": "long" }, { - "description": "the details for the storage pool", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "details", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the cluster ID for the storage pool", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, "type": "uuid" }, { - "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "hypervisor", + "name": "istagarule", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "the details for the storage pool", "length": 255, - "name": "capacityiops", + "name": "details", "required": false, - "type": "long" + "type": "map" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "description": "the URL of the storage pool", "length": 255, - "name": "istagarule", - "required": false, - "type": "boolean" + "name": "url", + "required": true, + "type": "string" }, { "description": "bytes CloudStack can provision from this storage pool", @@ -117286,10 +118199,10 @@ "type": "long" }, { - "description": "the Pod ID for the storage pool", + "description": "the cluster ID for the storage pool", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, @@ -117301,18 +118214,24 @@ "type": "string" }, { - "description": "the Zone ID for the storage pool", + "description": "the name for the storage pool", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the URL of the storage pool", + "description": "the storage provider name", "length": 255, - "name": "url", - "required": true, + "name": "provider", + "required": false, + "type": "string" + }, + { + "description": "the tags for the storage pool", + "length": 255, + "name": "tags", + "required": false, "type": "string" }, { @@ -117323,9 +118242,9 @@ "type": "boolean" }, { - "description": "the storage provider name", + "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": "provider", + "name": "hypervisor", "required": false, "type": "string" } @@ -117333,54 +118252,59 @@ "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the ID of the storage pool", - "name": "id", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { "description": "the Pod ID of the storage pool", @@ -117388,66 +118312,81 @@ "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { "description": "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 storage pool path", "name": "path", "type": "string" }, - {}, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, + {}, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "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 type", + "name": "type", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, + { + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + }, + { + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, { "description": "the storage pool capabilities", "name": "storagecapabilities", @@ -117458,34 +118397,21 @@ "name": "hasannotations", "type": "boolean" }, + {} + ] + }, + { + "description": "Lists storage pools available for migration of a volume.", + "isasync": false, + "name": "findStoragePoolsForMigration", + "params": [ { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - {}, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" - }, - { - "description": "the 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": "the ID of the volume", "length": 255, @@ -117507,31 +118433,20 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "cancelStorageMaintenance,enableStorageMaintenance", "response": [ { - "description": "the storage pool path", - "name": "path", - "type": "string" - }, - { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, + {}, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { "description": "the name of the storage pool", @@ -117539,18 +118454,18 @@ "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { @@ -117558,40 +118473,34 @@ "name": "podname", "type": "string" }, - {}, - { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" - }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { @@ -117600,45 +118509,54 @@ "type": "integer" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { "description": "the Zone ID of the storage pool", @@ -117646,24 +118564,25 @@ "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, + {}, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" } ] }, @@ -117679,13 +118598,6 @@ "required": true, "type": "string" }, - { - "description": "Tungsten-Fabric tag value", - "length": 255, - "name": "tagvalue", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -117693,14 +118605,21 @@ "related": "createZone,listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric tag value", + "length": 255, + "name": "tagvalue", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -117708,65 +118627,65 @@ "type": "integer" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, - {}, { - "description": "list Tungsten-Fabric policy", - "name": "policy", + "description": "list Tungsten-Fabric nic", + "name": "nic", "type": "list" } ] }, { - "description": "Adds an OpenDaylight controller", + "description": "Adds an OpenDyalight controler", "isasync": true, "name": "addOpenDaylightController", "params": [ { - "description": "Username to access the OpenDaylight API", + "description": "Credential to access the OpenDaylight API", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "Credential to access the OpenDaylight API", + "description": "Username to access the OpenDaylight API", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, @@ -117789,40 +118708,40 @@ "related": "", "response": [ { - "description": "the name assigned to the controller", - "name": "name", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, + {}, { - "description": "device id of the controller", - "name": "id", + "description": "the url of the controller api", + "name": "url", "type": "string" }, {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the url of the controller api", - "name": "url", - "type": "string" - }, - { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "device id of the controller", + "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name assigned to the controller", + "name": "name", "type": "string" } ] @@ -117849,26 +118768,26 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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" } ] @@ -117879,159 +118798,186 @@ "name": "createZone", "params": [ { - "description": "true if the zone is an edge zone, false otherwise", + "description": "true if network is security group enabled, false otherwise", "length": 255, - "name": "isedge", + "name": "securitygroupenabled", "required": false, - "since": "4.18.0", "type": "boolean" }, { - "description": "the first DNS for the Zone", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "dns1", - "required": true, - "type": "string" + "name": "localstorageenabled", + "required": false, + "type": "boolean" }, { - "description": "Allocation state of this Zone for allocation of new resources", + "description": "Network domain name for the networks in the zone", "length": 255, - "name": "allocationstate", + "name": "domain", "required": false, "type": "string" }, { - "description": "network type of the zone, can be Basic or Advanced", + "description": "the ID of the containing domain, null for public zones", "length": 255, - "name": "networktype", - "required": true, - "type": "string" + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the name of the Zone", + "description": "Allocation state of this Zone for allocation of new resources", "length": 255, - "name": "name", - "required": true, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "Network domain name for the networks in the zone", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "domain", - "required": false, + "name": "internaldns1", + "required": true, "type": "string" }, { - "description": "the second DNS for the Zone", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "dns2", + "name": "ip6dns1", "required": false, "type": "string" }, { - "description": "the ID of the containing domain, null for public zones", + "description": "the name of the Zone", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "true if network is security group enabled, false otherwise", + "description": "the first DNS for the Zone", "length": 255, - "name": "securitygroupenabled", - "required": false, - "type": "boolean" + "name": "dns1", + "required": true, + "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "network type of the zone, can be Basic or Advanced", "length": 255, - "name": "internaldns1", + "name": "networktype", "required": true, "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "localstorageenabled", + "name": "internaldns2", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the guest CIDR address for the Zone", + "description": "true if the zone is an edge zone, false otherwise", "length": 255, - "name": "guestcidraddress", + "name": "isedge", "required": false, - "type": "string" + "since": "4.18.0", + "type": "boolean" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "the second DNS for the Zone", "length": 255, - "name": "ip6dns1", + "name": "dns2", "required": false, "type": "string" }, { - "description": "the second internal DNS for the Zone", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "internaldns2", + "name": "ip6dns2", "required": false, "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "ip6dns2", + "name": "guestcidraddress", "required": false, "type": "string" } ], "related": "listZones", "response": [ - { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, { "description": "the display text of the zone", "name": "displaytext", "type": "string" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the list of resource tags associated with zone.", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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 maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" }, { "description": "the second DNS for the Zone", @@ -118039,69 +118985,64 @@ "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "Zone name", + "name": "name", "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": "Zone Token", - "name": "zonetoken", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, {}, { - "description": "Zone id", - "name": "id", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { @@ -118114,13 +119055,8 @@ "type": "string" }, { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { @@ -118129,34 +119065,29 @@ "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { "description": "the capacity type", @@ -118164,90 +119095,57 @@ "type": "short" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" } ], "type": "list" }, - {}, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "Zone Token", + "name": "zonetoken", + "type": "string" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { "description": "Zone description", @@ -118255,9 +119153,30 @@ "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" + }, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" } ] }, @@ -118282,55 +119201,41 @@ "name": "vsmpktvlanid", "type": "int" }, - { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", - "type": "string" - }, - { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", - "type": "string" - }, { "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", "name": "vsmdomainid", "type": "string" }, - {}, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, + {}, { "description": "storage vlan id of the VSM", "name": "vsmstoragevlanid", "type": "int" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { @@ -118338,16 +119243,30 @@ "name": "vsmdevicestate", "type": "string" }, - {}, { - "description": "device name", - "name": "vsmdevicename", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", + "type": "string" + }, + { + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { "description": "control vlan id of the VSM", "name": "vsmctrlvlanid", "type": "int" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", + "type": "string" } ] }, @@ -118356,13 +119275,6 @@ "isasync": true, "name": "createStorageNetworkIpRange", "params": [ - { - "description": "the gateway for storage network", - "length": 255, - "name": "gateway", - "required": true, - "type": "string" - }, { "description": "the ending IP address", "length": 255, @@ -118371,12 +119283,19 @@ "type": "string" }, { - "description": "the beginning IP address", + "description": "the netmask for storage network", "length": 255, - "name": "startip", + "name": "netmask", "required": true, "type": "string" }, + { + "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table", + "length": 255, + "name": "vlan", + "required": false, + "type": "integer" + }, { "description": "UUID of pod where the ip range belongs to", "length": 255, @@ -118386,56 +119305,56 @@ "type": "uuid" }, { - "description": "the netmask for storage network", + "description": "the beginning IP address", "length": 255, - "name": "netmask", + "name": "startip", "required": true, "type": "string" }, { - "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table", + "description": "the gateway for storage network", "length": 255, - "name": "vlan", - "required": false, - "type": "integer" + "name": "gateway", + "required": true, + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the netmask of the storage network IP range", + "name": "netmask", "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 end ip of the storage network IP range", - "name": "endip", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "the gateway of the storage network IP range", + "name": "gateway", + "type": "string" }, { "description": "the network uuid of storage network IP range", "name": "networkid", "type": "string" }, + {}, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, { @@ -118444,9 +119363,9 @@ "type": "integer" }, { - "description": "the uuid of storage network IP range.", - "name": "id", - "type": "string" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, { "description": "the Pod uuid for the storage network IP range", @@ -118454,8 +119373,8 @@ "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, {} @@ -118468,40 +119387,34 @@ "name": "listDomainChildren", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "list children domain by parent domain ID.", "length": 255, - "name": "listall", + "name": "id", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "flag to display the resource icon for domains", + "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", "length": 255, - "name": "showicon", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "List by keyword", + "description": "list children domains by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, - { - "description": "list children domains by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -118510,12 +119423,11 @@ "type": "integer" }, { - "description": "list children domain by parent domain ID.", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -118523,40 +119435,41 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "flag to display the resource icon for domains", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" } ], "related": "listDomains", "response": [ { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" - }, - {}, - { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { "description": "the network domain", @@ -118564,78 +119477,84 @@ "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "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 domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" }, + {}, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the path of the domain", + "name": "path", "type": "string" }, { @@ -118644,145 +119563,145 @@ "type": "long" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "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 total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the path of the domain", - "name": "path", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, - {}, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", - "type": "string" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the ID of the domain", + "name": "id", + "type": "string" } ] }, @@ -118802,22 +119721,22 @@ ], "related": "", "response": [ + {}, + { + "description": "The base64 encoded encrypted password of the VM", + "name": "encryptedpassword", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - {}, - { - "description": "The base64 encoded encrypted password of the VM", - "name": "encryptedpassword", - "type": "string" } ] }, @@ -118851,27 +119770,27 @@ } ], "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -118880,13 +119799,6 @@ "isasync": true, "name": "configureOvsElement", "params": [ - { - "description": "Enabled/Disabled the service provider", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - }, { "description": "the ID of the ovs provider", "length": 255, @@ -118894,23 +119806,30 @@ "related": "configureOvsElement", "required": true, "type": "uuid" + }, + { + "description": "Enabled/Disabled the service provider", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" } ], "related": "", "response": [ { - "description": "the id of the ovs", - "name": "id", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the id of the ovs", + "name": "id", "type": "string" }, { @@ -118918,15 +119837,16 @@ "name": "account", "type": "string" }, + {}, + {}, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { @@ -118939,17 +119859,16 @@ "name": "enabled", "type": "boolean" }, - { - "description": "the domain ID associated with the provider", - "name": "domainid", - "type": "string" - }, { "description": "the project name of the address", "name": "project", "type": "string" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -118958,32 +119877,25 @@ "name": "addImageStoreS3", "params": [ { - "description": "S3 secret key", - "length": 255, - "name": "secretkey", - "required": true, - "type": "string" - }, - { - "description": "Connection TTL (milliseconds)", + "description": "Maximum number of times to retry on error", "length": 255, - "name": "connectionttl", + "name": "maxerrorretry", "required": false, "type": "integer" }, { - "description": "Connection timeout (milliseconds)", + "description": "Socket timeout (milliseconds)", "length": 255, - "name": "connectiontimeout", + "name": "sockettimeout", "required": false, "type": "integer" }, { - "description": "Whether TCP keep-alive is used", + "description": "S3 access key", "length": 255, - "name": "usetcpkeepalive", - "required": false, - "type": "boolean" + "name": "accesskey", + "required": true, + "type": "string" }, { "description": "S3 endpoint", @@ -118993,121 +119905,128 @@ "type": "string" }, { - "description": "Use HTTPS instead of HTTP", + "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", "length": 255, - "name": "usehttps", + "name": "s3signer", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Maximum number of times to retry on error", + "description": "Name of the storage bucket", "length": 255, - "name": "maxerrorretry", + "name": "bucket", + "required": true, + "type": "string" + }, + { + "description": "Connection timeout (milliseconds)", + "length": 255, + "name": "connectiontimeout", "required": false, "type": "integer" }, { - "description": "S3 access key", + "description": "Whether TCP keep-alive is used", "length": 255, - "name": "accesskey", - "required": true, - "type": "string" + "name": "usetcpkeepalive", + "required": false, + "type": "boolean" }, { - "description": "Name of the storage bucket", + "description": "S3 secret key", "length": 255, - "name": "bucket", + "name": "secretkey", "required": true, "type": "string" }, { - "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", + "description": "Use HTTPS instead of HTTP", "length": 255, - "name": "s3signer", + "name": "usehttps", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Socket timeout (milliseconds)", + "description": "Connection TTL (milliseconds)", "length": 255, - "name": "sockettimeout", + "name": "connectionttl", "required": false, "type": "integer" } ], "related": "listImageStores", "response": [ - {}, { - "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 total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the name of the image store", + "name": "name", + "type": "string" }, { "description": "the Zone name of the image store", "name": "zonename", "type": "string" }, - {}, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "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": "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the protocol of the image store", + "name": "protocol", "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 total disk size of the host", + "name": "disksizetotal", + "type": "long" }, + {}, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the name of the image store", - "name": "name", + "description": "the url of the image store", + "name": "url", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ], "since": "4.7.0" @@ -119118,9 +120037,9 @@ "name": "uploadTemplateDirectDownloadCertificate", "params": [ { - "description": "Hypervisor type", + "description": "Name for the uploaded certificate", "length": 255, - "name": "hypervisor", + "name": "name", "required": true, "type": "string" }, @@ -119128,17 +120047,10 @@ "description": "(optional) the host ID to upload certificate", "length": 255, "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": false, "type": "uuid" }, - { - "description": "SSL certificate", - "length": 65535, - "name": "certificate", - "required": true, - "type": "string" - }, { "description": "Zone to upload certificate", "length": 255, @@ -119148,9 +120060,16 @@ "type": "uuid" }, { - "description": "Name for the uploaded certificate", + "description": "SSL certificate", + "length": 65535, + "name": "certificate", + "required": true, + "type": "string" + }, + { + "description": "Hypervisor type", "length": 255, - "name": "name", + "name": "hypervisor", "required": true, "type": "string" } @@ -119163,40 +120082,34 @@ "type": "string" }, { - "description": "the direct download certificate id", - "name": "id", - "type": "string" - }, - { - "description": "the direct download certificate serial num", - "name": "serialnum", + "description": "the direct download certificate issuer", + "name": "validity", "type": "string" }, + {}, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "the direct download certificate version", + "name": "version", "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "validity", - "type": "string" + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" }, - {}, { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, { - "description": "the direct download certificate version", - "name": "version", + "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 hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", "type": "string" }, { @@ -119209,10 +120122,16 @@ "name": "alias", "type": "string" }, + {}, { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" + "description": "the direct download certificate id", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -119220,8 +120139,8 @@ "type": "integer" }, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the zone name where the certificate is uploaded", + "name": "zonename", "type": "string" } ], @@ -119232,13 +120151,6 @@ "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, - "type": "boolean" - }, { "description": "the cluster ID", "length": 255, @@ -119248,47 +120160,56 @@ "type": "uuid" }, { - "description": "the ID of the template for the virtual machine", + "description": "used to specify the custom parameters.", "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the host name of the instance", + "description": "VM nic to network id mapping using keys nic and network", "length": 255, - "name": "hostname", + "name": "nicnetworklist", "required": false, - "type": "string" + "type": "map" }, { - "description": "the name of the instance as it is known to the hypervisor", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "datadiskofferinglist", + "required": false, + "type": "map" }, { - "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", + "description": "import instance for the project", "length": 255, - "name": "forced", + "name": "projectid", + "related": "activateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "the name of the instance as it is known to the hypervisor", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the display name of the instance", + "description": "import instance to the domain specified", "length": 255, - "name": "displayname", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { "description": "VM nic to ip address mapping using keys nic, ip4Address", @@ -119298,77 +120219,55 @@ "type": "map" }, { - "description": "VM nic to network id mapping using keys nic and network", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "nicnetworklist", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "description": "import instance for the project", + "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": "projectid", - "related": "activateProject", + "name": "migrateallowed", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "used to specify the custom parameters.", + "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": "details", + "name": "forced", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "the service offering for the virtual machine", + "description": "the host name of the instance", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "hostname", + "required": false, + "type": "string" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "datadiskofferinglist", + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "import instance to the domain specified", + "description": "the display name of the instance", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "displayname", "required": false, - "type": "uuid" + "type": "string" } ], "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", "response": [ { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "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 date when this virtual machine was created", @@ -119376,298 +120275,210 @@ "type": "date" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Guest vm Boot Mode", + "name": "bootmode", "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 disk 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 field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { "description": "the user's ID who deployed the virtual machine", "name": "userid", "type": "string" }, + {}, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + {}, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -119676,37 +120487,37 @@ "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", + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "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": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -119715,8 +120526,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -119725,101 +120536,54 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -119828,46 +120592,86 @@ "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "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": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, + { + "description": "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" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "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" }, { @@ -119885,19 +120689,14 @@ "name": "projectid", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -119906,92 +120705,144 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" - }, + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" } ], "type": "set" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "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 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 domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -120004,23 +120855,8 @@ "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 domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { @@ -120034,8 +120870,8 @@ "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { @@ -120047,39 +120883,44 @@ "description": "the account owning the affinity group", "name": "account", "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { "description": "the name of userdata used for the VM", @@ -120087,293 +120928,371 @@ "type": "string" }, { - "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 group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "tag value", - "name": "value", + "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 ID of the nic", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "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": "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 IPv6 address of network", + "name": "ip6address", + "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 (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ], "type": "set" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "VNF details", - "name": "vnfdetails", + "description": "Vm details in key/value pairs.", + "name": "details", "type": "map" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, + {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, - {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, - {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { "description": "the target memory in VM (KiB)", "name": "memorytargetkbs", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "name": "publicip", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "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 ISO attached to the virtual machine", - "name": "isoid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "true if 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 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": "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 memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the project name of the vm", + "name": "project", "type": "string" } ], @@ -120385,11 +121304,11 @@ "name": "listSystemVmsUsageHistory", "params": [ { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "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": "startdate", + "name": "name", "required": false, - "type": "date" + "type": "string" }, { "description": "the IDs of the system VMs, mutually exclusive with id.", @@ -120400,18 +121319,18 @@ "type": "list" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "", "length": 255, - "name": "enddate", + "name": "page", "required": false, - "type": "date" + "type": "integer" }, { - "description": "List by keyword", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "keyword", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { "description": "", @@ -120420,13 +121339,6 @@ "required": false, "type": "integer" }, - { - "description": "name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "the ID of the system VM.", "length": 255, @@ -120436,46 +121348,53 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, + {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the list of VM stats", "name": "stats", "type": "list" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" } ], "since": "4.18.0" @@ -120496,26 +121415,26 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "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" } ] }, @@ -120525,32 +121444,33 @@ "name": "createPhysicalNetwork", "params": [ { - "description": "the name of the physical network", + "description": "the isolation method for the physical network[VLAN/L3/GRE]", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "isolationmethods", + "required": false, + "type": "list" }, { - "description": "the speed for the physical network[1G/10G]", + "description": "the VLAN for the physical network", "length": 255, - "name": "networkspeed", + "name": "vlan", "required": false, "type": "string" }, { - "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", + "description": "the Zone ID for the physical network", "length": 255, - "name": "broadcastdomainrange", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the isolation method for the physical network[VLAN/L3/GRE]", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "isolationmethods", + "name": "networkspeed", "required": false, - "type": "list" + "type": "string" }, { "description": "domain ID of the account owning a physical network", @@ -120561,97 +121481,96 @@ "type": "uuid" }, { - "description": "Tag the physical network", + "description": "the name of the physical network", "length": 255, - "name": "tags", - "required": false, - "type": "list" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the VLAN for the physical network", + "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": "vlan", + "name": "broadcastdomainrange", "required": false, "type": "string" }, { - "description": "the Zone ID for the physical network", + "description": "Tag the physical network", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "tags", + "required": false, + "type": "list" } ], "related": "", "response": [ { - "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": "isolation methods", - "name": "isolationmethods", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "comma separated tag", + "name": "tags", "type": "string" }, - {}, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "name of the physical network", + "name": "name", "type": "string" }, + {}, { - "description": "state of the physical network", - "name": "state", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "comma separated tag", - "name": "tags", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, - {}, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "state of the physical network", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "isolation methods", + "name": "isolationmethods", + "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -120661,116 +121580,116 @@ "name": "listAutoScaleVmGroups", "params": [ { - "description": "", + "description": "the ID of the policy", "length": 255, - "name": "pagesize", + "name": "policyid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the name of the autoscale vmgroup", "length": 255, - "name": "fordisplay", + "name": "name", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "description": "the ID of the policy", + "description": "", "length": 255, - "name": "policyid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the availability zone ID", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the autoscale vm group", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "listAutoScaleVmGroups", + "name": "projectid", + "related": "activateProject", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the name of the autoscale vmgroup", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "name", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { - "description": "the ID of the loadbalancer", + "description": "the ID of the autoscale vm group", "length": 255, - "name": "lbruleid", - "related": "", + "name": "id", + "related": "listAutoScaleVmGroups", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the profile", + "description": "the ID of the loadbalancer", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile", + "name": "lbruleid", + "related": "", "required": false, "type": "uuid" }, { - "description": "", + "description": "the availability zone ID", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the profile", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "vmprofileid", + "related": "createAutoScaleVmProfile", "required": false, "type": "uuid" } @@ -120778,38 +121697,38 @@ "related": "", "response": [ { - "description": "the domain name of the vm group", - "name": "domain", - "type": "string" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "the project name of the vm group", + "name": "project", + "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { @@ -120818,19 +121737,24 @@ "type": "string" }, { - "description": "the public port", - "name": "publicport", - "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", - "name": "jobstatus", - "type": "integer" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" }, { "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", @@ -120838,71 +121762,66 @@ "type": "int" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "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 autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, - {}, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, - { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "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 domain ID of the vm group", - "name": "domainid", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, + {}, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, {}, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { "description": "the public ip address", @@ -120910,14 +121829,14 @@ "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -120927,18 +121846,12 @@ "name": "createFirewallRule", "params": [ { - "description": "type of firewallrule: system/user", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, - { - "description": "the ending port of firewall rule", + "description": "the IP address id of the port forwarding rule", "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -120948,6 +121861,13 @@ "since": "4.4", "type": "boolean" }, + { + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, { "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, @@ -120956,16 +121876,16 @@ "type": "string" }, { - "description": "type of the ICMP message being sent", + "description": "the ending port of firewall rule", "length": 255, - "name": "icmptype", + "name": "endport", "required": false, "type": "integer" }, { - "description": "error code for this icmp message", + "description": "the starting port of firewall rule", "length": 255, - "name": "icmpcode", + "name": "startport", "required": false, "type": "integer" }, @@ -120977,39 +121897,49 @@ "type": "list" }, { - "description": "the IP address id of the port forwarding rule", + "description": "type of the ICMP message being sent", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the starting port of firewall rule", + "description": "type of firewallrule: system/user", "length": 255, - "name": "startport", + "name": "type", "required": false, - "type": "integer" + "type": "string" } ], "related": "updateEgressFirewallRule", "response": [ + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + {}, + {}, { "description": "the ID of the firewall rule", "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the rule", + "name": "state", + "type": "string" }, - {}, { "description": "type of the icmp message being sent", "name": "icmptype", @@ -121021,23 +121951,23 @@ "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { @@ -121045,16 +121975,6 @@ "name": "cidrlist", "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 starting port of firewall rule's port range", "name": "startport", @@ -121065,43 +121985,43 @@ "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -121110,28 +122030,27 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "error code for this icmp message", "name": "icmpcode", "type": "integer" }, - {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -121141,62 +122060,64 @@ "name": "createVolume", "params": [ { - "description": "the account associated with the disk volume. 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": "the name of the disk volume", + "description": "the project associated with the volume. Mutually exclusive with account parameter", "length": 255, - "name": "name", + "name": "projectid", + "related": "activateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "max iops", + "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "maxiops", + "name": "snapshotid", + "related": "listSnapshots", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "Arbitrary volume size", + "description": "the ID of the availability zone", "length": 255, - "name": "size", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "an optional field, whether to display the volume to the end user or not.", + "description": "the account associated with the disk volume. Must be used with the domainId parameter.", "length": 255, - "name": "displayvolume", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", + "description": "the name of the disk volume", "length": 255, - "name": "virtualmachineid", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain.", + "description": "max iops", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "maxiops", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "min iops", + "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": "miniops", + "name": "virtualmachineid", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", "required": false, - "type": "long" + "type": "uuid" }, { "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", @@ -121207,83 +122128,71 @@ "type": "uuid" }, { - "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", + "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": "snapshotid", - "related": "listSnapshots", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "min iops", "length": 255, - "name": "customid", + "name": "miniops", "required": false, - "type": "string" + "type": "long" }, { - "description": "the project associated with the volume. Mutually exclusive with account parameter", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "customid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the availability zone", + "description": "Arbitrary volume size", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "size", "required": false, - "type": "uuid" + "type": "long" } ], "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, { "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { "description": "the display text of the service offering for root disk", @@ -121291,35 +122200,10 @@ "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "size of the disk volume", + "name": "size", "type": "long" }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, { "description": "the bytes actually consumed on disk", "name": "virtualsize", @@ -121329,6 +122213,11 @@ "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", @@ -121340,33 +122229,28 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -121375,218 +122259,248 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, {}, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - {}, { - "description": "state of the virtual machine", - "name": "vmstate", + "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": "name of the virtual machine", - "name": "vmname", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, + {}, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, { "description": "the bytes allocated", "name": "physicalsize", "type": "long" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "the 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 to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { @@ -121595,44 +122509,49 @@ "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" } ] }, @@ -121641,13 +122560,6 @@ "isasync": false, "name": "listVMSnapshot", "params": [ - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -121657,27 +122569,34 @@ "type": "uuid" }, { - "description": "The ID of the VM snapshot", + "description": "List by keyword", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "state of the virtual machine snapshot", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "the ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "activateProject", "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.", @@ -121687,12 +122606,20 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "lists snapshot by snapshot name or display name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, + { + "description": "The ID of the VM snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -121700,6 +122627,13 @@ "required": false, "type": "integer" }, + { + "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, @@ -121710,16 +122644,9 @@ "type": "list" }, { - "description": "state of the virtual machine snapshot", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "lists snapshot by snapshot name or display name", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, @@ -121731,36 +122658,34 @@ "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,importVm", - "required": false, - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "tags", + "name": "isrecursive", "required": false, - "type": "map" + "type": "boolean" } ], "related": "createVMSnapshot", "response": [ + {}, + { + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" + }, { "description": "the Zone ID of the vm snapshot", "name": "zoneid", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { @@ -121769,13 +122694,8 @@ "type": "string" }, { - "description": "the description of the vm snapshot", - "name": "description", - "type": "string" - }, - { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -121783,54 +122703,65 @@ "name": "displayname", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the parent displayName of the vm snapshot", "name": "parentName", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", "type": "string" }, + {}, { - "description": "the project name of the vpn", - "name": "project", + "description": "the Zone name of the vm snapshot", + "name": "zonename", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" + "description": "the ID of the vm snapshot", + "name": "id", + "type": "string" }, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" + }, + { + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "the ID of the vm snapshot", - "name": "id", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "VM Snapshot type", - "name": "type", + "description": "the description of the vm snapshot", + "name": "description", "type": "string" }, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "VM Snapshot type", + "name": "type", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { @@ -121838,23 +122769,28 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "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": "tag value", + "name": "value", "type": "string" }, { @@ -121868,59 +122804,42 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, - {}, - { - "description": "the current status of the latest async job acting 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 create date of the vm snapshot", + "name": "created", + "type": "date" }, { - "description": "the name of the vm snapshot", - "name": "name", + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", "type": "string" }, { - "description": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" - }, - {}, - { - "description": "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 state of the vm snapshot", - "name": "state", - "type": "state" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" } ], "since": "4.2.0" @@ -121931,44 +122850,44 @@ "name": "updatePod", "params": [ { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the starting IP address for the Pod", "length": 255, - "name": "allocationstate", + "name": "startip", "required": false, "type": "string" }, { - "description": "the ending IP address for the Pod", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "endip", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the name of the Pod", + "description": "the netmask of the Pod", "length": 255, - "name": "name", + "name": "netmask", "required": false, "type": "string" }, { - "description": "the gateway for the Pod", + "description": "the ending IP address for the Pod", "length": 255, - "name": "gateway", + "name": "endip", "required": false, "type": "string" }, { - "description": "the netmask of the Pod", + "description": "the name of the Pod", "length": 255, - "name": "netmask", + "name": "name", "required": false, "type": "string" }, { - "description": "the starting IP address for the Pod", + "description": "the gateway for the Pod", "length": 255, - "name": "startip", + "name": "gateway", "required": false, "type": "string" }, @@ -121983,19 +122902,23 @@ ], "related": "createManagementNetworkIpRange", "response": [ - {}, + { + "description": "the name of the Pod", + "name": "name", + "type": "string" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" + }, { "description": "the IP ranges for the Pod", "name": "ipranges", "response": [ { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { @@ -122009,76 +122932,123 @@ "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" } ], "type": "list" }, { - "description": "the name of the Pod", - "name": "name", + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" + }, + {}, + { + "description": "the gateway of the Pod", + "name": "gateway", + "type": "string" + }, + { + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" + }, { "description": "the Zone ID of the Pod", "name": "zoneid", "type": "string" }, { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the ID of the Pod", - "name": "id", - "type": "string" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", "name": "endip", "type": "list" }, + { + "description": "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": "the Zone name of the Pod", + "name": "zonename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the capacity of the Pod", "name": "capacity", "response": [ { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the capacity name", - "name": "name", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "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 Pod name", + "name": "podname", + "type": "string" }, { "description": "the capacity currently in use", @@ -122086,78 +123056,27 @@ "type": "long" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Zone ID", + "name": "zoneid", "type": "string" } ], "type": "list" - }, - { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" - }, - {}, - { - "description": "the gateway of the Pod", - "name": "gateway", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - }, - { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" } ] }, @@ -122167,52 +123086,57 @@ "name": "moveNetworkAclItem", "params": [ { - "description": "The ID of the network ACL rule that is being moved to a new position.", + "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": "id", - "required": true, + "name": "aclconsistencyhash", + "required": false, "type": "string" }, { - "description": "The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list.", + "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": "nextaclruleid", + "name": "previousaclruleid", "required": false, "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "The ID of the network ACL rule that is being moved to a new position.", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "name": "id", + "required": true, "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).", + "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": "aclconsistencyhash", + "name": "nextaclruleid", "required": false, "type": "string" }, { - "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": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "previousaclruleid", + "name": "customid", "required": false, + "since": "4.4", "type": "string" } ], "related": "", "response": [ { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -122221,40 +123145,29 @@ "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the protocol of the ACL", + "name": "protocol", "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 ID of the ACL this item belongs to", - "name": "aclid", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { "description": "is rule for display to the regular user", @@ -122266,87 +123179,93 @@ "name": "endport", "type": "string" }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "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 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": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project 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": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, {}, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + {}, { - "description": "Number of the ACL Item", - "name": "number", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" } ] @@ -122356,14 +123275,6 @@ "isasync": true, "name": "attachIso", "params": [ - { - "description": "If true, ejects existing ISO before attaching on VMware. Default: false", - "length": 255, - "name": "forced", - "required": false, - "since": "4.15.1", - "type": "boolean" - }, { "description": "the ID of the ISO file", "length": 255, @@ -122372,6 +123283,14 @@ "required": true, "type": "uuid" }, + { + "description": "If true, ejects existing ISO before attaching on VMware. Default: false", + "length": 255, + "name": "forced", + "required": false, + "since": "4.15.1", + "type": "boolean" + }, { "description": "the ID of the virtual machine", "length": 255, @@ -122384,1035 +123303,1035 @@ "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", "response": [ { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the group name of the virtual machine", + "name": "group", "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 template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "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": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "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 vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "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", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the 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": "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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 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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the 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 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": "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" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the 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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the 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 name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { "description": "the outgoing network traffic on the host in KiB", "name": "networkkbswrite", "type": "long" }, + {}, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ], + "type": "set" }, - {}, { - "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 user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "name": "publicip", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, { "description": "the ID of the service offering of the virtual machine", "name": "serviceofferingid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, - {}, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - } - ], - "type": "set" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "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 account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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 group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ + }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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": "tag value", - "name": "value", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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": "id of the resource", - "name": "resourceid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" } ], "type": "set" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "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 name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" } ] }, @@ -123441,26 +124360,26 @@ "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "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" - }, - {} + } ] }, { @@ -123468,6 +124387,13 @@ "isasync": false, "name": "listBaremetalDhcp", "params": [ + { + "description": "Type of DHCP device", + "length": 255, + "name": "dhcpservertype", + "required": false, + "type": "string" + }, { "description": "List by keyword", "length": 255, @@ -123484,11 +124410,11 @@ "type": "uuid" }, { - "description": "Type of DHCP device", + "description": "DHCP server device ID", "length": 255, - "name": "dhcpservertype", + "name": "id", "required": false, - "type": "string" + "type": "long" }, { "description": "", @@ -123497,13 +124423,6 @@ "required": false, "type": "integer" }, - { - "description": "DHCP server device ID", - "length": 255, - "name": "id", - "required": false, - "type": "long" - }, { "description": "", "length": 255, @@ -123514,20 +124433,10 @@ ], "related": "", "response": [ - { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, {}, { - "description": "name of the provider", - "name": "dhcpservertype", - "type": "string" - }, - { - "description": "url", - "name": "url", + "description": "device id of ", + "name": "id", "type": "string" }, { @@ -123535,21 +124444,31 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "device id of ", - "name": "id", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "name of the provider", + "name": "dhcpservertype", "type": "string" }, { "description": "name of the provider", "name": "provider", "type": "string" + }, + { + "description": "url", + "name": "url", + "type": "string" } ] }, @@ -123570,69 +124489,55 @@ "related": "cancelStorageMaintenance", "response": [ { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, - { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" - }, { "description": "the Zone ID of the storage pool", "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the name of the storage pool", - "name": "name", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { "description": "the host's currently used disk size", @@ -123640,29 +124545,38 @@ "type": "long" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, - {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the storage pool path", + "name": "path", + "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": "the Pod ID of the storage pool", - "name": "podid", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "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 IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { @@ -123671,13 +124585,14 @@ "type": "map" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, + {}, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { @@ -123686,35 +124601,39 @@ "type": "date" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the storage pool type", - "name": "type", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, { "description": "IOPS CloudStack can provision from this storage pool", "name": "capacityiops", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the storage pool type", + "name": "type", "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -123734,56 +124653,56 @@ ], "related": "", "response": [ - { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" - }, - { - "description": "ID of the heuristic.", - "name": "id", - "type": "string" - }, + {}, { "description": "Name of the heuristic.", "name": "name", "type": "string" }, {}, - {}, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, { "description": "Description of the heuristic.", "name": "description", "type": "string" }, + { + "description": "When the heuristic was created.", + "name": "created", + "type": "date" + }, + { + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", + "type": "string" + }, { "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", "name": "type", "type": "string" }, { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" + "description": "ID of the heuristic.", + "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 zone which the heuristic is valid upon.", - "name": "zoneid", + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "type": "string" } ], @@ -123797,13 +124716,18 @@ "related": "", "response": [ { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", + "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" }, { @@ -123812,37 +124736,32 @@ "type": "integer" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", "type": "string" }, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "DN password", - "name": "bindpass", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, - {}, { "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", "name": "searchbase", "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "description": "DN password", + "name": "bindpass", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {}, + {} ], "since": "3.0.1" }, @@ -123852,47 +124771,46 @@ "name": "createUser", "params": [ { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "lastname", "length": 255, - "name": "account", + "name": "lastname", "required": true, "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "firstname", "length": 255, - "name": "timezone", - "required": false, + "name": "firstname", + "required": true, "type": "string" }, { - "description": "lastname", + "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": "lastname", + "name": "password", "required": true, "type": "string" }, { - "description": "firstname", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "firstname", - "required": true, + "name": "timezone", + "required": false, "type": "string" }, { - "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": "Unique username.", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "userid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "email", @@ -123902,36 +124820,43 @@ "type": "string" }, { - "description": "Unique username.", + "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", "length": 255, - "name": "username", + "name": "account", "required": true, "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", "length": 255, - "name": "userid", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" } ], "related": "getUser", "response": [ { - "description": "the domain name of the user", - "name": "domain", + "description": "the user ID", + "name": "id", "type": "string" }, + {}, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { "description": "the ID of the role", @@ -123939,18 +124864,18 @@ "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -123959,18 +124884,23 @@ "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, { @@ -123979,25 +124909,20 @@ "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, {}, { - "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 source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "the account name of the user", @@ -124005,49 +124930,43 @@ "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the type of the role", - "name": "roletype", + "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 user name", + "name": "username", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" }, - {}, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the domain name of the user", + "name": "domain", "type": "string" } ] @@ -124068,42 +124987,64 @@ "related": "", "response": [ { - "description": "the name of the api command", - "name": "name", + "description": "description of the api", + "name": "description", "type": "string" }, + {}, { "description": "comma separated related apis", "name": "related", "type": "string" }, + { + "description": "the name of the api command", + "name": "name", + "type": "string" + }, + { + "description": "api response fields", + "name": "response", + "response": [ + { + "description": "the name of the api response field", + "name": "name", + "type": "string" + }, + { + "description": "response field type", + "name": "type", + "type": "string" + }, + { + "description": "description of the api response field", + "name": "description", + "type": "string" + }, + { + "description": "api response fields", + "name": "response", + "type": "set" + } + ], + "type": "set" + }, { "description": "the current status of the latest 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": "response field type", + "name": "type", "type": "string" }, {}, - { - "description": "description of the api", - "name": "description", - "type": "string" - }, { "description": "version of CloudStack the api was introduced in", "name": "since", "type": "string" }, - {}, - { - "description": "true if api is asynchronous", - "name": "isasync", - "type": "boolean" - }, { "description": "the list params the api accepts", "name": "params", @@ -124114,8 +125055,13 @@ "type": "string" }, { - "description": "description of the api parameter", - "name": "description", + "description": "true if this parameter is required for the api request", + "name": "required", + "type": "boolean" + }, + { + "description": "the name of the api parameter", + "name": "name", "type": "string" }, { @@ -124123,60 +125069,33 @@ "name": "length", "type": "int" }, - { - "description": "true if this parameter is required for the api request", - "name": "required", - "type": "boolean" - }, { "description": "version of CloudStack the api was introduced in", "name": "since", "type": "string" }, { - "description": "parameter type", - "name": "type", + "description": "description of the api parameter", + "name": "description", "type": "string" }, { - "description": "the name of the api parameter", - "name": "name", + "description": "parameter type", + "name": "type", "type": "string" } ], "type": "set" }, { - "description": "response field type", - "name": "type", - "type": "string" + "description": "true if api is asynchronous", + "name": "isasync", + "type": "boolean" }, { - "description": "api response fields", - "name": "response", - "response": [ - { - "description": "response field type", - "name": "type", - "type": "string" - }, - { - "description": "description of the api response field", - "name": "description", - "type": "string" - }, - { - "description": "api response fields", - "name": "response", - "type": "set" - }, - { - "description": "the name of the api response field", - "name": "name", - "type": "string" - } - ], - "type": "set" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.1.0" @@ -124196,27 +125115,27 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -124225,14 +125144,6 @@ "isasync": true, "name": "createVpnGateway", "params": [ - { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "public ip address id of the vpn gateway", "length": 255, @@ -124240,28 +125151,32 @@ "related": "createVPC,listVPCs,updateVPC", "required": true, "type": "uuid" + }, + { + "description": "an optional field, whether to the display the vpn to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "", "response": [ { - "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": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the domain name of the owner", - "name": "domain", + "description": "the owner", + "name": "account", "type": "string" }, + {}, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { @@ -124269,35 +125184,34 @@ "name": "fordisplay", "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the owner", - "name": "account", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, { @@ -124305,12 +125219,17 @@ "name": "projectid", "type": "string" }, + {}, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the project name", + "name": "project", "type": "string" }, - {} + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + } ] }, { @@ -124319,18 +125238,12 @@ "name": "createVMSnapshot", "params": [ { - "description": "The description of the snapshot", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, - { - "description": "The display name of the snapshot", + "description": "The ID of the vm", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "virtualmachineid", + "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "required": true, + "type": "uuid" }, { "description": "snapshot memory if true", @@ -124347,145 +125260,54 @@ "type": "boolean" }, { - "description": "The ID of the vm", + "description": "The description of the snapshot", "length": 255, - "name": "virtualmachineid", - "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", - "type": "string" - }, - { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", - "type": "string" - }, - {}, - { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "name": "description", + "required": false, "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "The display name of the snapshot", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, - { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" - }, + } + ], + "related": "", + "response": [ { "description": "the parent displayName of the vm snapshot", "name": "parentName", "type": "string" }, - { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "indicates if this is current snapshot", "name": "current", "type": "boolean" }, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", - "type": "string" - }, - { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the description of the vm snapshot", - "name": "description", - "type": "string" - }, - { - "description": "the name of the vm snapshot", - "name": "name", - "type": "string" - }, - { - "description": "the display name of the vm snapshot", - "name": "displayname", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the vm snapshot", - "name": "id", - "type": "string" - }, - { - "description": "VM Snapshot type", - "name": "type", + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -124499,37 +125321,134 @@ "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", "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" } ], "type": "set" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "VM Snapshot type", + "name": "type", + "type": "string" + }, + { + "description": "the description of the vm snapshot", + "name": "description", + "type": "string" + }, + { + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the vm snapshot", + "name": "id", + "type": "string" + }, + { + "description": "the name of the vm snapshot", + "name": "name", + "type": "string" + }, + { + "description": "the Zone name of the vm snapshot", + "name": "zonename", + "type": "string" + }, + {}, { "description": "the parent ID of the vm snapshot", "name": "parent", "type": "string" }, { - "description": "the 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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the display name of the vm snapshot", + "name": "displayname", + "type": "string" + }, + { + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { "description": "the domain associated with the disk volume", "name": "domain", "type": "string" + }, + {}, + { + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", + "type": "string" } ], "since": "4.2.0" @@ -124540,19 +125459,11 @@ "name": "addResourceDetail", "params": [ { - "description": "Map of (key/value pairs)", + "description": "resource id to create the details for", "length": 255, - "name": "details", + "name": "resourceid", "required": true, - "type": "map" - }, - { - "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" + "type": "string" }, { "description": "type of the resource", @@ -124562,23 +125473,32 @@ "type": "string" }, { - "description": "resource id to create the details for", + "description": "Map of (key/value pairs)", "length": 255, - "name": "resourceid", + "name": "details", "required": true, - "type": "string" + "type": "map" + }, + { + "description": "pass false if you want this detail to be disabled for the regular user. True by default", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "response": [ + {}, { "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", @@ -124586,11 +125506,10 @@ "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" } ] }, @@ -124600,75 +125519,75 @@ "name": "listVpnUsers", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "activateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The uuid of the Vpn user", + "description": "the username of the vpn user.", "length": 255, - "name": "id", - "related": "addVpnUser,listVpnUsers", + "name": "username", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the username of the vpn user.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "username", + "name": "account", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The uuid of the Vpn user", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "id", + "related": "addVpnUser,listVpnUsers", "required": false, "type": "uuid" } @@ -124676,57 +125595,57 @@ "related": "addVpnUser", "response": [ { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the username of the vpn user", - "name": "username", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the username of the vpn user", + "name": "username", "type": "string" }, + {}, { "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", "name": "state", "type": "string" }, - {}, - { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" - }, { "description": "the vpn userID", "name": "id", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", + "type": "string" }, { "description": "the 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" + } ] }, { @@ -124744,27 +125663,27 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.2.0" @@ -124784,16 +125703,6 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -124805,6 +125714,16 @@ "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" } ] }, @@ -124828,10 +125747,10 @@ "type": "string" }, { - "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "description": "an optional project for the userdata", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "activateProject", "required": false, "type": "uuid" }, @@ -124843,10 +125762,10 @@ "type": "string" }, { - "description": "an optional project for the userdata", + "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, @@ -124859,27 +125778,27 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.18" @@ -124890,11 +125809,11 @@ "name": "addRegion", "params": [ { - "description": "Name of the region", + "description": "Id of the Region", "length": 255, - "name": "name", + "name": "id", "required": true, - "type": "string" + "type": "integer" }, { "description": "Region service endpoint", @@ -124904,51 +125823,51 @@ "type": "string" }, { - "description": "Id of the Region", + "description": "Name of the region", "length": 255, - "name": "id", + "name": "name", "required": true, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "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 name of the region", + "name": "name", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the end point of the region", "name": "endpoint", "type": "string" }, + {}, { - "description": "the name of the region", - "name": "name", - "type": "string" + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" }, { - "description": "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": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" } ] }, @@ -124958,11 +125877,18 @@ "name": "listTungstenFabricTagType", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric tag type", + "length": 255, + "name": "tagtypeuuid", + "required": false, + "type": "string" }, { "description": "the ID of zone", @@ -124980,18 +125906,11 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric tag type", - "length": 255, - "name": "tagtypeuuid", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", @@ -125001,33 +125920,33 @@ "name": "zonename", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, { "description": "Tungsten-Fabric tag type name", "name": "name", "type": "string" }, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - } + {} ] }, { @@ -125035,6 +125954,13 @@ "isasync": false, "name": "generateUsageRecords", "params": [ + { + "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "length": 255, + "name": "enddate", + "required": true, + "type": "date" + }, { "description": "List events for the specified domain.", "length": 255, @@ -125043,13 +125969,6 @@ "required": false, "type": "uuid" }, - { - "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", - "length": 255, - "name": "enddate", - "required": true, - "type": "date" - }, { "description": "Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.", "length": 255, @@ -125059,9 +125978,15 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -125070,17 +125995,11 @@ "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -125089,21 +126008,29 @@ "name": "updateRolePermission", "params": [ { - "description": "Role permission rule id", + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "length": 255, - "name": "ruleid", + "name": "ruleorder", "related": "", "required": false, - "since": "4.11", + "type": "list" + }, + { + "description": "ID of the role", + "length": 255, + "name": "roleid", + "related": "", + "required": true, "type": "uuid" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "Role permission rule id", "length": 255, - "name": "ruleorder", + "name": "ruleid", "related": "", "required": false, - "type": "list" + "since": "4.11", + "type": "uuid" }, { "description": "Rule permission, can be: allow or deny", @@ -125112,38 +126039,30 @@ "required": false, "since": "4.11", "type": "string" - }, - { - "description": "ID of the role", - "length": 255, - "name": "roleid", - "related": "", - "required": true, - "type": "uuid" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.9.0" @@ -125154,25 +126073,19 @@ "name": "listSSHKeyPairs", "params": [ { - "description": "A key pair name to look for", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "A public key fingerprint to look for", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "fingerprint", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -125183,102 +126096,105 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the ID of the ssh keypair", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "listSSHKeyPairs", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "A public key fingerprint to look for", "length": 255, - "name": "keyword", + "name": "fingerprint", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the ssh keypair", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "id", + "related": "listSSHKeyPairs", "required": false, "type": "uuid" + }, + { + "description": "A key pair name to look for", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "Name of the keypair", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "ID of the ssh keypair", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the project name of the keypair owner", "name": "project", "type": "string" }, + {}, { - "description": "the owner of the keypair", - "name": "account", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, + {}, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, { @@ -125286,12 +126202,15 @@ "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the owner of the keypair", + "name": "account", + "type": "string" + }, + { + "description": "Name of the keypair", + "name": "name", + "type": "string" } ] }, @@ -125301,16 +126220,24 @@ "name": "listAccounts", "params": [ { - "description": "list accounts by cleanuprequired attribute (values are true or false)", + "description": "list account by account name", "length": 255, - "name": "iscleanuprequired", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "flag to display the resource icon for accounts", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "showicon", + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", "required": false, "type": "boolean" }, @@ -125322,12 +126249,11 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "details", "required": false, - "type": "uuid" + "type": "list" }, { "description": "List by keyword", @@ -125336,13 +126262,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -125351,30 +126270,30 @@ "type": "integer" }, { - "description": "list accounts by state. Valid states are enabled, disabled, and locked.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "state", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list accounts by cleanuprequired attribute (values are true or false)", "length": 255, - "name": "isrecursive", + "name": "iscleanuprequired", "required": false, "type": "boolean" }, { - "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", + "description": "list accounts by state. Valid states are enabled, disabled, and locked.", "length": 255, - "name": "details", + "name": "state", "required": false, - "type": "list" + "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": "flag to display the resource icon for accounts", "length": 255, - "name": "listall", + "name": "showicon", "required": false, "type": "boolean" }, @@ -125387,58 +126306,53 @@ "type": "uuid" }, { - "description": "list account by account name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "enableAccount,listAccounts", "response": [ { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the type of the role", - "name": "roletype", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { "description": "the user ID", @@ -125446,53 +126360,48 @@ "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": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user email address", - "name": "email", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the api key of the user", + "name": "apikey", + "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { @@ -125500,19 +126409,19 @@ "name": "domainid", "type": "string" }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, { "description": "the date and time the user account was created", "name": "created", "type": "date" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -125521,9 +126430,9 @@ "type": "string" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { "description": "the user lastname", @@ -125531,72 +126440,98 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" } ], "type": "list" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, + {}, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { "description": "the total secondary storage space (in GiB) the account can own", @@ -125609,59 +126544,59 @@ "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the state of the account", + "name": "state", + "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { "description": "the total number of virtual machines deployed by this account", @@ -125669,74 +126604,74 @@ "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" - }, { "description": "the total number of vpcs the account can own", "name": "vpclimit", "type": "string" }, - {}, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, + {}, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { @@ -125745,14 +126680,9 @@ "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { "description": "the total number of public ip addresses this account can acquire", @@ -125760,69 +126690,58 @@ "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, - {}, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "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 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 name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" } ] @@ -125844,78 +126763,59 @@ "related": "", "response": [ { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, + {}, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { @@ -125923,51 +126823,49 @@ "name": "clusterid", "type": "string" }, - {}, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { "description": "the name of the storage pool", "name": "name", "type": "string" }, + { + "description": "the storage pool type", + "name": "type", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the storage pool path", - "name": "path", - "type": "string" - }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { @@ -125981,14 +126879,35 @@ "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" } ] }, @@ -126009,8 +126928,50 @@ "related": "", "response": [ { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "list" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { @@ -126019,13 +126980,39 @@ "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + {}, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { @@ -126033,68 +127020,68 @@ "name": "nic", "response": [ { - "description": "the ID of the nic", - "name": "id", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -126103,13 +127090,18 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -126118,29 +127110,24 @@ "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the netmask of the nic", + "name": "netmask", "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "device id for the network when plugged into the virtual machine", @@ -126148,86 +127135,86 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, { "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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 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", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" } ], "type": "set" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "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 public IP address for the router", - "name": "publicip", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -126236,38 +127223,28 @@ "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { @@ -126276,197 +127253,139 @@ "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": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - } - ], - "type": "list" - }, { "description": "the ID of the corresponding link local network", "name": "linklocalnetworkid", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the id of the router", + "name": "id", "type": "string" }, {}, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" } ] @@ -126503,6 +127422,58 @@ ], "related": "", "response": [ + {}, + { + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" + }, + { + "description": "the ID of the snapshot policy", + "name": "id", + "type": "string" + }, + { + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, + { + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, + { + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", @@ -126513,13 +127484,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -126528,68 +127499,100 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, - {}, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" - }, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Lists balance and quota usage for all accounts", + "isasync": false, + "name": "quotaSummary", + "params": [ { - "description": "the ID of the snapshot policy", - "name": "id", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "Optional, Account Id for which statement needs to be generated", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" + "description": "Optional, to list all accounts irrespective of the quota activity", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "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" + } + ], + "related": "", + "response": [ + { + "description": "start date", + "name": "startdate", + "type": "date" }, { "description": "the UUID of the latest async job acting on this object", @@ -126597,27 +127600,64 @@ "type": "string" }, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", + "description": "if the account has the quota config enabled", + "name": "quotaenabled", "type": "boolean" }, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "description": "account balance", + "name": "balance", + "type": "bigdecimal" + }, + { + "description": "account id", + "name": "accountid", + "type": "string" + }, + { + "description": "currency", + "name": "currency", + "type": "string" + }, + { + "description": "quota usage of this period", + "name": "quota", + "type": "bigdecimal" + }, + { + "description": "account name", + "name": "account", + "type": "string" + }, + { + "description": "domain id", + "name": "domainid", + "type": "string" }, {}, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "domain name", + "name": "domain", + "type": "string" + }, + { + "description": "account state", + "name": "state", + "type": "state" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "end date", + "name": "enddate", + "type": "date" } - ] + ], + "since": "4.7.0" }, { "description": "Retrieves the current status of asynchronous job.", @@ -126635,51 +127675,47 @@ ], "related": "", "response": [ - {}, - { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" - }, - { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", - "type": "long" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the result type", + "name": "jobresulttype", + "type": "string" + }, { "description": " the completed date of the job", "name": "completed", "type": "date" }, { - "description": "the domain that executed the async command", - "name": "domainpath", - "type": "string" - }, - { - "description": "the user that executed the async command", - "name": "userid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the domain id that executed the async command", "name": "domainid", "type": "string" }, + {}, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" + }, + { + "description": "the user that executed the async command", + "name": "userid", "type": "string" }, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" + "description": "the async command executed", + "name": "cmd", + "type": "string" }, { "description": "the result reason", @@ -126687,45 +127723,49 @@ "type": "responseobject" }, { - "description": "the account that executed the async command", - "name": "account", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", - "type": "string" + "description": "the current job status-should be 0 for PENDING", + "name": "jobstatus", + "type": "integer" }, { "description": "the progress information of the PENDING job", "name": "jobprocstatus", "type": "integer" }, - {}, { - "description": "the async command executed", - "name": "cmd", + "description": " the created date of the job", + "name": "created", + "type": "date" + }, + { + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", + "type": "long" + }, + { + "description": "the account that executed the async command", + "name": "account", "type": "string" }, { - "description": "the result type", - "name": "jobresulttype", + "description": "the domain that executed the async command", + "name": "domainpath", "type": "string" }, { - "description": " the created date of the job", - "name": "created", - "type": "date" + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", + "type": "string" }, { "description": "the account id that executed the async command", "name": "accountid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -126735,25 +127775,25 @@ "name": "registerNetscalerControlCenter", "params": [ { - "description": "Credentials to reach netscaler controlcenter device", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "numretries", + "name": "password", "required": true, - "type": "integer" + "type": "string" }, { "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "username", + "name": "numretries", "required": true, - "type": "string" + "type": "integer" }, { "description": "URL of the netscaler controlcenter appliance.", @@ -126766,13 +127806,8 @@ "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", "response": [ { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" - }, - { - "description": "device name", - "name": "lbdevicename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -126780,78 +127815,83 @@ "name": "provider", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the physical network to which this netscaler device belongs to", "name": "physicalnetworkid", "type": "string" }, - {}, - { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" - }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" }, + {}, { "description": "true if NetScaler device is provisioned to be a GSLB service provider", "name": "gslbprovider", "type": "boolean" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "device state", - "name": "lbdevicestate", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, - {} + { + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + { + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" + } ] }, { @@ -126860,39 +127900,31 @@ "name": "listImageStores", "params": [ { - "description": "read-only status of the image store", - "length": 255, - "name": "readonly", - "related": "listImageStores", - "required": false, - "since": "4.15.0", - "type": "boolean" - }, - { - "description": "", + "description": "the image store provider", "length": 255, - "name": "pagesize", + "name": "provider", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the image store provider", + "description": "the Zone ID for the image store", "length": 255, - "name": "provider", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the name of the image store", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, @@ -126905,19 +127937,27 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "the name of the image store", "length": 255, - "name": "keyword", + "name": "name", "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": "read-only status of the image store", + "length": 255, + "name": "readonly", + "related": "listImageStores", + "required": false, + "since": "4.15.0", + "type": "boolean" }, { "description": "the image store protocol", @@ -126929,30 +127969,41 @@ ], "related": "", "response": [ + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, { "description": "the name of the image store", "name": "name", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the url of the image store", + "name": "url", + "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, + {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -126966,40 +128017,29 @@ "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 Zone name of the image store", - "name": "zonename", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { "description": "the provider name of the image store", "name": "providername", "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 ID of the image store", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.2.0" @@ -127019,13 +128059,6 @@ } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -127036,6 +128069,13 @@ "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", @@ -127049,24 +128089,24 @@ "name": "createCounter", "params": [ { - "description": "Network provider of the counter.", + "description": "Value of the counter e.g. oid in case of snmp.", "length": 255, - "name": "provider", + "name": "value", "required": true, - "since": "4.18.0", "type": "string" }, { - "description": "Name of the counter.", + "description": "Network provider of the counter.", "length": 255, - "name": "name", + "name": "provider", "required": true, + "since": "4.18.0", "type": "string" }, { - "description": "Value of the counter e.g. oid in case of snmp.", + "description": "Name of the counter.", "length": 255, - "name": "value", + "name": "name", "required": true, "type": "string" }, @@ -127081,19 +128121,19 @@ "related": "", "response": [ { - "description": "zone id of counter", - "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": "zone id of counter", + "name": "zoneid", + "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the counter.", + "name": "name", "type": "string" }, { @@ -127102,26 +128142,26 @@ "type": "string" }, { - "description": "Source of the counter.", - "name": "source", + "description": "the id of the Counter", + "name": "id", "type": "string" }, { - "description": "Provider of the counter.", - "name": "provider", + "description": "Source of the counter.", + "name": "source", "type": "string" }, + {}, { - "description": "Name of the counter.", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of the Counter", - "name": "id", + "description": "Provider of the counter.", + "name": "provider", "type": "string" - }, - {} + } ] }, { @@ -127133,10 +128173,60 @@ "response": [ {}, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Event Type", "name": "name", "type": "string" + } + ] + }, + { + "description": "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": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + }, + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "long" + }, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" + }, + {}, + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -127148,7 +128238,8 @@ "name": "jobstatus", "type": "integer" } - ] + ], + "since": "4.19.0" }, { "description": "Disables out-of-band management for a cluster", @@ -127167,95 +128258,60 @@ "related": "", "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 operation result description", - "name": "description", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, { "description": "the out-of-band management driver for the host", "name": "driver", "type": "string" }, + {}, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { "description": "the ID of the host", "name": "hostid", "type": "string" }, - {}, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" }, + {}, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "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": "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": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", "type": "boolean" }, { @@ -127263,35 +128319,27 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" - }, - { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" - }, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "the operation result description", + "name": "description", + "type": "string" } ], - "since": "4.19.0" + "since": "4.9.0" }, { "description": "Adds a new cluster", "isasync": false, "name": "addCluster", "params": [ + { + "description": "the Zone ID for the cluster", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { "description": "Ovm3 native OCFS2 clustering enabled for cluster", "length": 255, @@ -127299,6 +128347,20 @@ "required": false, "type": "string" }, + { + "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", + "length": 255, + "name": "publicvswitchname", + "required": false, + "type": "string" + }, + { + "description": "Ovm3 vip to use for pool (and cluster)", + "length": 255, + "name": "ovm3vip", + "required": false, + "type": "string" + }, { "description": "the Pod ID for the host", "length": 255, @@ -127308,10 +128370,10 @@ "type": "uuid" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "clustertype", - "required": true, + "name": "allocationstate", + "required": false, "type": "string" }, { @@ -127329,31 +128391,31 @@ "type": "string" }, { - "description": "Ovm3 vip to use for pool (and cluster)", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "ovm3vip", - "required": false, + "name": "clustertype", + "required": true, "type": "string" }, { - "description": "the password for the host", + "description": "the username for the VSM associated with this cluster", "length": 255, - "name": "password", + "name": "vsmusername", "required": false, "type": "string" }, { - "description": "the password for the VSM associated with this cluster", + "description": "the password for the host", "length": 255, - "name": "vsmpassword", + "name": "password", "required": false, "type": "string" }, { - "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", + "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", "length": 255, - "name": "guestvswitchtype", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { @@ -127364,104 +128426,69 @@ "type": "string" }, { - "description": "Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", - "length": 255, - "name": "publicvswitchtype", - "required": false, - "type": "string" - }, - { - "description": "the username for the cluster", + "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "username", + "name": "guestvswitchname", "required": false, "type": "string" }, { - "description": "the ipaddress of the VSM associated with this cluster", + "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", "length": 255, - "name": "vsmipaddress", + "name": "guestvswitchtype", "required": false, "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the password for the VSM associated with this cluster", "length": 255, - "name": "allocationstate", + "name": "vsmpassword", "required": false, "type": "string" }, { - "description": "the username for the VSM associated with this cluster", + "description": "Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", "length": 255, - "name": "vsmusername", + "name": "publicvswitchtype", "required": false, "type": "string" }, { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - }, - { - "description": "the Zone ID for the cluster", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "description": "the username for the cluster", "length": 255, - "name": "guestvswitchname", + "name": "username", "required": false, "type": "string" }, { - "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", + "description": "the ipaddress of the VSM associated with this cluster", "length": 255, - "name": "publicvswitchname", + "name": "vsmipaddress", "required": false, "type": "string" } ], "related": "", "response": [ - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, + {}, + {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -127470,8 +128497,13 @@ "type": "long" }, { - "description": "the capacity name", - "name": "name", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { @@ -127480,8 +128512,8 @@ "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { @@ -127490,14 +128522,14 @@ "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { "description": "the total capacity available", @@ -127505,32 +128537,31 @@ "type": "long" }, { - "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" } ], "type": "list" }, - {}, { - "description": "the cluster name", - "name": "name", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { @@ -127539,34 +128570,43 @@ "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "whether this cluster is managed by cloudstack", "name": "managedstate", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the cluster ID", + "name": "id", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", "type": "string" }, { @@ -127575,14 +128615,14 @@ "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" } ] }, @@ -127595,33 +128635,33 @@ "description": "Id of the Traffic Monitor Host.", "length": 255, "name": "id", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": true, "type": "uuid" } ], "response": [ + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -127650,256 +128690,53 @@ "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", "response": [ { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the project name of the vm", - "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - {}, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { @@ -127908,307 +128745,108 @@ "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the 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 ID of the corresponding network", - "name": "networkid", - "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 IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - } - ], - "type": "set" + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, { "description": "Name of AutoScale VM group", "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -128217,8 +128855,84 @@ "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "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", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -128227,23 +128941,38 @@ "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -128251,133 +128980,67 @@ "name": "groupid", "type": "string" }, + {}, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "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": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", + "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "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": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -128386,51 +129049,56 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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" }, { @@ -128439,74 +129107,171 @@ "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the 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", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" } ], "type": "set" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -128515,18 +129280,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the 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" } ], @@ -128538,23 +129303,33 @@ "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -128563,60 +129338,111 @@ "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" + } + ], + "type": "set" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain ID of the security group", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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": "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 ID who deployed the virtual machine", - "name": "userid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -128625,59 +129451,273 @@ "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "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": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "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 domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, - {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "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": "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "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": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, + {}, { - "description": "the state of the virtual machine", - "name": "state", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" } ] @@ -128699,53 +129739,78 @@ "related": "", "response": [ { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, + { + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" + }, { "description": "the total number of vpcs available to be created for this project", "name": "vpcavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { @@ -128754,32 +129819,43 @@ "type": "long" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "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 allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the name of the project", + "name": "name", + "type": "string" }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -128788,209 +129864,173 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, { - "description": "the name of the project", - "name": "name", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "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" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the id of the project", - "name": "id", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, - {}, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, - {}, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the domain name where the project belongs to", "name": "domain", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, + {}, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" } ], "since": "3.0.0" @@ -129010,27 +130050,27 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "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" } ] }, @@ -129039,13 +130079,28 @@ "isasync": false, "name": "listDedicatedHosts", "params": [ + { + "description": "the name of the account associated with the host. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, + { + "description": "list dedicated hosts by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -129057,17 +130112,10 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": false, "type": "uuid" }, - { - "description": "the name of the account associated with the host. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "the ID of the domain associated with the host", "length": 255, @@ -129079,17 +130127,9 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "list dedicated hosts by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "", @@ -129099,15 +130139,19 @@ "name": "domainid", "type": "string" }, - {}, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + }, + { + "description": "the Account ID of the host", + "name": "accountid", "type": "string" }, { @@ -129115,16 +130159,12 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, { "description": "the Dedication Affinity Group ID of the host", "name": "affinitygroupid", "type": "string" }, + {}, { "description": "the name of the host", "name": "hostname", @@ -129144,9 +130184,9 @@ "name": "getUploadParamsForIso", "params": [ { - "description": "Upload volume/template/iso for the project", + "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": "projectid", + "name": "ostypeid", "related": "", "required": false, "type": "uuid" @@ -129159,17 +130199,16 @@ "type": "string" }, { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "ostypeid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "bootable", + "name": "ispublic", "required": false, "type": "boolean" }, @@ -129181,11 +130220,11 @@ "type": "boolean" }, { - "description": "the display text of the ISO. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "length": 255, + "name": "bootable", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the name of the volume/template/iso", @@ -129194,6 +130233,14 @@ "required": true, "type": "string" }, + { + "description": "Upload volume/template/iso for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, @@ -129203,9 +130250,16 @@ "type": "uuid" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "the display text of the ISO. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "ispublic", + "name": "isextractable", "required": false, "type": "boolean" }, @@ -129216,13 +130270,6 @@ "required": true, "type": "string" }, - { - "description": "true if the ISO or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" - }, { "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, @@ -129230,27 +130277,14 @@ "related": "listDomains", "required": false, "type": "uuid" - }, - { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" }, { "description": "POST url to upload the file to", @@ -129258,18 +130292,24 @@ "type": "url" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" }, + {}, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "signature to be sent in the POST request.", + "name": "signature", "type": "string" }, {}, @@ -129309,18 +130349,18 @@ "name": "jobid", "type": "string" }, - {}, { "description": "Storage URL to download retrieve diagnostics data files", "name": "url", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ], "since": "4.14.0.0" }, @@ -129329,14 +130369,6 @@ "isasync": true, "name": "deleteAutoScaleVmGroup", "params": [ - { - "description": "the ID of the autoscale group", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "true if all VMs have to be cleaned up, false otherwise", "length": 255, @@ -129344,9 +130376,28 @@ "required": false, "since": "4.18.0", "type": "boolean" + }, + { + "description": "the ID of the autoscale group", + "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": "any text associated with the success or failure", "name": "displaytext", @@ -129357,17 +130408,6 @@ "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" - }, {} ] }, @@ -129377,73 +130417,73 @@ "name": "listPaloAltoFirewalls", "params": [ { - "description": "Palo Alto firewall device ID", + "description": "", "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,listPaloAltoFirewalls", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "Palo Alto firewall device ID", "length": 255, - "name": "keyword", + "name": "fwdeviceid", + "related": "addPaloAltoFirewall,listPaloAltoFirewalls", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "page", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "addPaloAltoFirewall", "response": [ { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { @@ -129452,60 +130492,60 @@ "type": "integer" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, + {}, { - "description": "device name", - "name": "fwdevicename", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "the management IP address of the external firewall", + "name": "ipaddress", + "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, - {}, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" } ] @@ -129515,6 +130555,13 @@ "isasync": true, "name": "updateLoadBalancerRule", "params": [ + { + "description": "the name of the load balancer rule", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -129523,6 +130570,14 @@ "since": "4.4", "type": "boolean" }, + { + "description": "the ID of the load balancer rule to update", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + }, { "description": "The protocol for the LB", "length": 255, @@ -129531,9 +130586,9 @@ "type": "string" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, "type": "string" }, @@ -129546,48 +130601,44 @@ "type": "string" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, - "type": "string" - }, - { - "description": "the name of the load balancer rule", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "name", + "name": "algorithm", "required": false, "type": "string" - }, - { - "description": "the ID of the load balancer rule to update", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" } ], "related": "listLoadBalancerRules", "response": [ { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, + {}, { - "description": "the 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 public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -129596,18 +130647,44 @@ "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the private port", + "name": "privateport", + "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" }, { @@ -129616,18 +130693,23 @@ "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -129635,33 +130717,33 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the 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" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -129670,73 +130752,31 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, - {}, { "description": "the name of the load balancer", "name": "name", "type": "string" }, { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - {}, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the public ip address", - "name": "publicip", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" } ] @@ -129753,14 +130793,6 @@ "required": false, "type": "date" }, - { - "description": "the IDs of the alerts", - "length": 255, - "name": "ids", - "related": "", - "required": false, - "type": "list" - }, { "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, @@ -129774,6 +130806,14 @@ "name": "type", "required": false, "type": "string" + }, + { + "description": "the IDs of the alerts", + "length": 255, + "name": "ids", + "related": "", + "required": false, + "type": "list" } ], "response": [ @@ -129782,23 +130822,23 @@ "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {} + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -129806,14 +130846,6 @@ "isasync": false, "name": "enableAccount", "params": [ - { - "description": "Account id", - "length": 255, - "name": "id", - "related": "enableAccount,listAccounts", - "required": false, - "type": "uuid" - }, { "description": "Enables specified account in this domain.", "length": 255, @@ -129828,120 +130860,136 @@ "name": "account", "required": false, "type": "string" + }, + { + "description": "Account id", + "length": 255, + "name": "id", + "related": "enableAccount,listAccounts", + "required": false, + "type": "uuid" } ], "related": "listAccounts", "response": [ { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - {}, - { - "description": "the ID of the role", - "name": "roleid", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, - {}, { - "description": "the name of the role", - "name": "rolename", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -129950,8 +130998,23 @@ "type": "resourceiconresponse" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { @@ -129964,19 +131027,70 @@ "name": "created", "type": "date" }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + {}, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the user ID", - "name": "id", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" }, { "description": "the account type of the user", @@ -129984,78 +131098,73 @@ "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the user firstname", + "name": "firstname", "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 ID of the role", - "name": "roleid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the user email address", - "name": "email", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user state", + "name": "state", "type": "string" }, { @@ -130064,202 +131173,133 @@ "type": "boolean" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" } ], "type": "list" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the state of the account", - "name": "state", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, { "description": "the name of the account", "name": "name", "type": "string" }, - { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, + {}, { "description": "the total number of templates which can be created by this account", "name": "templatelimit", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "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 total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" } ] }, @@ -130269,35 +131309,21 @@ "name": "createAutoScaleVmProfile", "params": [ { - "description": "account that will own the autoscale VM profile", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "domain ID of the account owning a autoscale VM profile", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "an optional project for the autoscale VM profile", "length": 255, - "name": "autoscaleuserid", - "related": "getUser", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "the ID of the Userdata", "length": 255, - "name": "userdatadetails", + "name": "userdataid", + "related": "", "required": false, "since": "4.18.1", - "type": "map" + "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", @@ -130308,13 +131334,28 @@ "type": "string" }, { - "description": "an optional project for the autoscale VM profile", + "description": "domain ID of the account owning a autoscale VM profile", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, + { + "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": "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 time allowed for existing connections to get closed before a vm is expunged", "length": 255, @@ -130331,21 +131372,12 @@ "type": "uuid" }, { - "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 Userdata", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "userdataid", - "related": "", + "name": "userdatadetails", "required": false, "since": "4.18.1", - "type": "uuid" + "type": "map" }, { "description": "an optional field, whether to the display the profile to the end user or not", @@ -130363,6 +131395,13 @@ "required": true, "type": "uuid" }, + { + "description": "account that will own the autoscale VM profile", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", "length": 255, @@ -130371,34 +131410,34 @@ "type": "map" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine.\nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "description": "the ID of the user used to launch and destroy the VMs", "length": 255, - "name": "otherdeployparams", + "name": "autoscaleuserid", + "related": "getUser", "required": false, - "type": "map" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", - "type": "string" + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { @@ -130407,19 +131446,19 @@ "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, { "description": "Base 64 encoded VM user data", @@ -130428,61 +131467,62 @@ }, {}, { - "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 template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, {}, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, {}, + {}, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", - "type": "string" + "description": "the 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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -130492,71 +131532,71 @@ "name": "registerOauthProvider", "params": [ { - "description": "Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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", + "description": "Secret Key pre-registered in the specific OAuth provider", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "secretkey", + "required": true, + "type": "string" }, { - "description": "Client ID pre-registered in the specific OAuth provider", + "description": "Redirect URI pre-registered in the specific OAuth provider", "length": 255, - "name": "clientid", + "name": "redirecturi", "required": true, "type": "string" }, { - "description": "Name of the provider from the list of OAuth providers supported in CloudStack", + "description": "Description of the OAuth Provider", "length": 255, - "name": "provider", + "name": "description", "required": true, "type": "string" }, { - "description": "Redirect URI pre-registered in the specific OAuth provider", + "description": "Name of the provider from the list of OAuth providers supported in CloudStack", "length": 255, - "name": "redirecturi", + "name": "provider", "required": true, "type": "string" }, { - "description": "Description of the OAuth Provider", + "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": "description", - "required": true, - "type": "string" + "name": "details", + "required": false, + "type": "map" }, { - "description": "Secret Key pre-registered in the specific OAuth provider", + "description": "Client ID pre-registered in the specific OAuth provider", "length": 255, - "name": "secretkey", + "name": "clientid", "required": true, "type": "string" } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.19.0" }, @@ -130565,6 +131605,13 @@ "isasync": false, "name": "listLBStickinessPolicies", "params": [ + { + "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, @@ -130581,32 +131628,25 @@ "required": false, "type": "uuid" }, - { - "description": "the ID of the load balancer stickiness policy", - "length": 255, - "name": "id", - "related": "listLBStickinessPolicies", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of the load balancer stickiness policy", "length": 255, - "name": "keyword", + "name": "id", + "related": "listLBStickinessPolicies", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -130614,33 +131654,25 @@ "related": "", "response": [ { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" }, + {}, { "description": "the account of the Stickiness policy", "name": "account", "type": "string" }, - { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", - "type": "string" - }, + {}, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the params of the policy", - "name": "params", - "type": "map" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the LB Stickiness policy ID", @@ -130648,8 +131680,8 @@ "type": "string" }, { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { @@ -130658,53 +131690,61 @@ "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the params of the policy", + "name": "params", + "type": "map" + }, + { + "description": "the method name of the Stickiness policy", + "name": "methodname", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the state of the policy", "name": "state", "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, - {}, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" } ], @@ -130723,57 +131763,56 @@ "type": "string" }, { - "description": "the name of UCS manager", + "description": "the username of UCS", "length": 255, - "name": "name", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "the Zone id for the ucs manager", + "description": "the name of UCS manager", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { - "description": "the username of UCS", + "description": "the password of UCS", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "the password of UCS", + "description": "the Zone id for the ucs manager", "length": 255, - "name": "password", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the name of ucs manager", - "name": "name", + "description": "the url of ucs manager", + "name": "url", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the zone ID of ucs manager", + "name": "zoneid", "type": "string" }, { @@ -130782,10 +131821,11 @@ "type": "string" }, { - "description": "the url of ucs manager", - "name": "url", + "description": "the name of ucs manager", + "name": "name", "type": "string" - } + }, + {} ] }, { @@ -130810,17 +131850,12 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -130831,6 +131866,11 @@ "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ] }, @@ -130843,7 +131883,7 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": true, "type": "uuid" } @@ -130851,19 +131891,9 @@ "related": "addBaremetalHost", "response": [ { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the 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": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", @@ -130871,34 +131901,38 @@ "type": "long" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, - {}, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "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" }, { @@ -130907,63 +131941,49 @@ "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the Pod ID of the host", - "name": "podid", + "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 percentage", - "name": "cpuallocatedpercentage", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { @@ -130972,131 +131992,91 @@ "type": "long" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, + {}, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "the date and time the host was created", - "name": "created", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, { "description": "the host hypervisor", "name": "hypervisor", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the host version", - "name": "version", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, - {}, { "description": "the total disk size of the host", "name": "disksizetotal", "type": "long" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "GPU cards present in the host", "name": "gpugroup", @@ -131105,11 +132085,6 @@ "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, { "description": "Video RAM for this vGPU type", "name": "videoram", @@ -131120,11 +132095,6 @@ "name": "maxheads", "type": "long" }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, { "description": "Maximum no. of vgpu per gpu card (pgpu)", "name": "maxvgpuperpgpu", @@ -131135,14 +132105,24 @@ "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 vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" } ], @@ -131157,34 +132137,84 @@ "type": "list" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "the cpu average load on the host", @@ -131197,29 +132227,39 @@ "type": "date" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "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 admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" } ] }, @@ -131229,12 +132269,12 @@ "name": "deleteVnfTemplate", "params": [ { - "description": "the ID of the template", + "description": "Force delete a template.", "length": 255, - "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "name": "forced", + "required": false, + "since": "4.9+", + "type": "boolean" }, { "description": "the ID of zone of the template", @@ -131245,37 +132285,37 @@ "type": "uuid" }, { - "description": "Force delete a template.", + "description": "the ID of the template", "length": 255, - "name": "forced", - "required": false, - "since": "4.9+", - "type": "boolean" + "name": "id", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "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", "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" }, @@ -131296,120 +132336,93 @@ "related": "", "response": [ { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", - "type": "string" - }, - { - "description": "the description of the Kubernetes cluster", - "name": "description", - "type": "string" - }, - {}, - { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" - }, - { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, - {}, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "keypair details", - "name": "keypair", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" - }, - { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { @@ -131418,18 +132431,35 @@ "type": "clustertype" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" + }, + {}, + { + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { @@ -131438,49 +132468,59 @@ "type": "list" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" + }, + { + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", "type": "long" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" + }, + { + "description": "keypair details", + "name": "keypair", + "type": "string" + }, + { + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", "type": "long" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" } ] }, @@ -131489,14 +132529,6 @@ "isasync": true, "name": "deleteProject", "params": [ - { - "description": "id of the project to be deleted", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "true if all project resources have to be cleaned up, false otherwise", "length": 255, @@ -131504,18 +132536,31 @@ "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { @@ -131523,11 +132568,6 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {} ], "since": "3.0.0" @@ -131538,26 +132578,27 @@ "name": "listNetscalerLoadBalancers", "params": [ { - "description": "netscaler load balancer device ID", + "description": "List by keyword", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "the Physical Network ID", "length": 255, - "name": "keyword", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "netscaler load balancer device ID", "length": 255, - "name": "pagesize", + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -131567,101 +132608,100 @@ "type": "integer" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "addNetscalerLoadBalancer", "response": [ { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "name of the provider", - "name": "provider", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", "type": "boolean" }, - {}, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "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", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "device name", + "name": "lbdevicename", + "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" }, + {}, { - "description": "device name", - "name": "lbdevicename", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" } ] @@ -131672,18 +132712,18 @@ "name": "createInstanceGroup", "params": [ { - "description": "The project of the instance group", + "description": "the domain ID of account owning the instance group", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the domain ID of account owning the instance group", + "description": "The project of the instance group", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, @@ -131710,56 +132750,56 @@ "type": "integer" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - {}, { "description": "the name of the instance group", "name": "name", "type": "string" }, + { + "description": "the domain ID of the instance group", + "name": "domainid", + "type": "string" + }, { "description": "time and date the instance group was created", "name": "created", "type": "date" }, + { + "description": "the domain name of the instance group", + "name": "domain", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, { "description": "the project ID of the instance group", "name": "projectid", "type": "string" }, + {}, { "description": "the account owning the instance group", "name": "account", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the ID of the instance group", "name": "id", "type": "string" - }, - { - "description": "the project name of the instance group", - "name": "project", - "type": "string" } ] }, @@ -131779,41 +132819,41 @@ ], "related": "listTemplatePermissions,listIsoPermissions", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the list of accounts the template is available for", "name": "account", "type": "list" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the ID of the domain to which the template belongs", "name": "domainid", "type": "string" }, + {}, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, {}, - {}, { "description": "the list of projects the template is available for", "name": "projectids", "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template ID", + "name": "id", "type": "string" } ] @@ -131824,10 +132864,18 @@ "name": "addNetscalerLoadBalancer", "params": [ { - "description": "public IP of the site", + "description": "the Physical Network ID", "length": 255, - "name": "gslbproviderpublicip", - "required": false, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "Credentials to reach netscaler load balancer device", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { @@ -131837,13 +132885,6 @@ "required": false, "type": "boolean" }, - { - "description": "URL of the netscaler load balancer appliance.", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, { "description": "private IP of the site", "length": 255, @@ -131859,9 +132900,16 @@ "type": "string" }, { - "description": "Credentials to reach netscaler load balancer device", + "description": "public IP of the site", "length": 255, - "name": "password", + "name": "gslbproviderpublicip", + "required": false, + "type": "string" + }, + { + "description": "URL of the netscaler load balancer appliance.", + "length": 255, + "name": "url", "required": true, "type": "string" }, @@ -131872,18 +132920,10 @@ "required": false, "type": "boolean" }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "Credentials to reach netscaler load balancer device", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" } @@ -131896,28 +132936,13 @@ "type": "string" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" - }, - { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { @@ -131926,46 +132951,55 @@ "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { "description": "the management IP address of the external load balancer", "name": "ipaddress", "type": "string" }, - {}, { - "description": "device state", - "name": "lbdevicestate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" }, - {}, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", "type": "boolean" }, + { + "description": "device name", + "name": "lbdevicename", + "type": "string" + }, { "description": "device id of the netscaler load balancer", "name": "lbdeviceid", "type": "string" }, { - "description": "device name", - "name": "lbdevicename", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "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": "name of the provider", @@ -131973,9 +133007,15 @@ "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" + }, + {}, + { + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" } ] }, @@ -131991,13 +133031,6 @@ "required": true, "type": "integer" }, - { - "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", - "length": 255, - "name": "instanceport", - "required": true, - "type": "integer" - }, { "description": "the network id of the source ip address", "length": 255, @@ -132007,12 +133040,11 @@ "type": "uuid" }, { - "description": "The guest network the load balancer will be created for", + "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "instanceport", "required": true, - "type": "uuid" + "type": "integer" }, { "description": "load balancer algorithm (source, roundrobin, leastconn)", @@ -132021,14 +133053,6 @@ "required": true, "type": "string" }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "the description of the load balancer", "length": 4096, @@ -132037,17 +133061,17 @@ "type": "string" }, { - "description": "the load balancer scheme. Supported value in this release is Internal", + "description": "the source IP address the network traffic will be load balanced from", "length": 255, - "name": "scheme", - "required": true, + "name": "sourceipaddress", + "required": false, "type": "string" }, { - "description": "the source IP address the network traffic will be load balanced from", + "description": "the load balancer scheme. Supported value in this release is Internal", "length": 255, - "name": "sourceipaddress", - "required": false, + "name": "scheme", + "required": true, "type": "string" }, { @@ -132056,75 +133080,110 @@ "name": "name", "required": true, "type": "string" + }, + { + "description": "The guest network the load balancer will be created for", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "", "response": [ { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", + "description": "the list of resource tags associated with the Load Balancer", + "name": "tags", "response": [ { - "description": "the state of the load balancer rule", - "name": "state", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "list" }, { - "description": "the Load Balancer ID", - "name": "id", + "description": "Load Balancer network id", + "name": "networkid", "type": "string" }, { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "Load Balancer source ip", + "name": "sourceipaddress", "type": "string" }, - {}, { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", "response": [ { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the state of the instance", - "name": "state", - "type": "string" + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" }, { - "description": "the name of the instance", - "name": "name", - "type": "string" + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" }, { - "description": "the instance ID", - "name": "id", + "description": "the state of the load balancer rule", + "name": "state", "type": "string" } ], @@ -132136,24 +133195,29 @@ "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the name of the Load Balancer", + "name": "name", + "type": "string" }, - {}, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the name of the Load Balancer", - "name": "name", + "description": "the domain of the Load Balancer", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the account of the Load Balancer", + "name": "account", "type": "string" }, { @@ -132161,86 +133225,62 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the domain ID of the Load Balancer", - "name": "domainid", - "type": "string" - }, { "description": "the project id of the Load Balancer", "name": "projectid", "type": "string" }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the state of the instance", + "name": "state", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the instance", + "name": "name", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the instance ID", + "name": "id", "type": "string" } ], "type": "list" }, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, + {}, { - "description": "the domain of the Load Balancer", - "name": "domain", + "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 description of the Load Balancer", + "name": "description", "type": "string" } ], @@ -132252,12 +133292,12 @@ "name": "removeNetworkPermissions", "params": [ { - "description": "the network ID", + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, - "type": "uuid" + "name": "accountids", + "related": "listAccounts", + "required": false, + "type": "list" }, { "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", @@ -132275,37 +133315,37 @@ "type": "list" }, { - "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "the network ID", "length": 255, - "name": "accountids", - "related": "listAccounts", - "required": false, - "type": "list" + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": true, + "type": "uuid" } ], "response": [ {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + } ], "since": "4.17.0" }, @@ -132332,6 +133372,16 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -132343,17 +133393,7 @@ "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" - } + {} ] }, { @@ -132362,55 +133402,44 @@ "name": "listBaremetalPxeServers", "params": [ { - "description": "the Physical Network ID", + "description": "Pxe server device ID", "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "name": "id", + "required": false, + "type": "long" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "Pxe server device ID", + "description": "List by keyword", "length": 255, - "name": "id", + "name": "keyword", "required": false, - "type": "long" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the Physical Network ID", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "name of the provider", "name": "provider", @@ -132421,16 +133450,27 @@ "name": "id", "type": "string" }, + {}, { - "description": "url", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the physical network to which this external dhcp device belongs to", "name": "physicalnetworkid", "type": "string" + }, + {}, + { + "description": "url", + "name": "url", + "type": "string" } ] }, @@ -132440,12 +133480,11 @@ "name": "addPaloAltoFirewall", "params": [ { - "description": "the Physical Network ID", + "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { "description": "URL of the Palo Alto appliance.", @@ -132455,9 +133494,9 @@ "type": "string" }, { - "description": "Credentials to reach Palo Alto firewall device", + "description": "supports only PaloAltoFirewall", "length": 255, - "name": "password", + "name": "networkdevicetype", "required": true, "type": "string" }, @@ -132469,33 +133508,24 @@ "type": "string" }, { - "description": "supports only PaloAltoFirewall", + "description": "the Physical Network ID", "length": 255, - "name": "networkdevicetype", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ - { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { "description": "the management IP address of the external firewall", "name": "ipaddress", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "type": "string" - }, - { - "description": "device state", - "name": "fwdevicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -132508,20 +133538,25 @@ "name": "publicinterface", "type": "string" }, - {}, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, + { + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, + {}, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { @@ -132530,46 +133565,51 @@ "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "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", + "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the 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 timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, + {}, { - "description": "name of the provider", - "name": "provider", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, - {} + { + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" + } ] }, { @@ -132578,9 +133618,17 @@ "name": "createPrivateGateway", "params": [ { - "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported", + "description": "the uuid of the network offering to use for the private gateways network connection", "length": 255, - "name": "sourcenatsupported", + "name": "networkofferingid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "when true bypasses VLAN id/range overlap check during private gateway creation", + "length": 255, + "name": "bypassvlanoverlapcheck", "required": false, "type": "boolean" }, @@ -132591,6 +133639,13 @@ "required": false, "type": "string" }, + { + "description": "the gateway of the Private gateway", + "length": 255, + "name": "gateway", + "required": true, + "type": "string" + }, { "description": "the VPC network belongs to", "length": 255, @@ -132599,6 +133654,13 @@ "required": true, "type": "uuid" }, + { + "description": "the netmask of the Private gateway", + "length": 255, + "name": "netmask", + "required": true, + "type": "string" + }, { "description": "The isolated network this private gateway is associated to.", "length": 255, @@ -132609,27 +133671,12 @@ "type": "uuid" }, { - "description": "the gateway of the Private gateway", + "description": "the IP address of the Private gateaway", "length": 255, - "name": "gateway", + "name": "ipaddress", "required": true, "type": "string" }, - { - "description": "the uuid of the network offering to use for the private gateways network connection", - "length": 255, - "name": "networkofferingid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "when true bypasses VLAN id/range overlap check during private gateway creation", - "length": 255, - "name": "bypassvlanoverlapcheck", - "required": false, - "type": "boolean" - }, { "description": "the Physical Network ID the network belongs to", "length": 255, @@ -132639,18 +133686,11 @@ "type": "uuid" }, { - "description": "the IP address of the Private gateaway", - "length": 255, - "name": "ipaddress", - "required": true, - "type": "string" - }, - { - "description": "the netmask of the Private gateway", + "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": "netmask", - "required": true, - "type": "string" + "name": "sourcenatsupported", + "required": false, + "type": "boolean" }, { "description": "the ID of the network ACL", @@ -132664,29 +133704,19 @@ "related": "createPrivateGateway,listPrivateGateways", "response": [ { - "description": "the id of the private gateway", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the private gateway", - "name": "projectid", - "type": "string" - }, - { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, {}, { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { @@ -132699,14 +133729,30 @@ "name": "ipaddress", "type": "string" }, + { + "description": "the account associated with the private gateway", + "name": "account", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + {}, { "description": "Source Nat enable status", "name": "sourcenatsupported", "type": "boolean" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "the project id of the private gateway", + "name": "projectid", + "type": "string" + }, + { + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { @@ -132715,18 +133761,18 @@ "type": "integer" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "zone id of the private gateway", + "name": "zoneid", "type": "string" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { @@ -132735,18 +133781,18 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, { @@ -132759,30 +133805,24 @@ "name": "gateway", "type": "string" }, - {}, - { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", - "type": "string" - }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the id of the private gateway", + "name": "id", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "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": "the physical network id", + "name": "physicalnetworkid", "type": "string" } ], @@ -132804,48 +133844,18 @@ "related": "", "response": [ { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the user lastname", - "name": "lastname", + "description": "the user email address", + "name": "email", "type": "string" }, { @@ -132859,18 +133869,8 @@ "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -132878,9 +133878,15 @@ "name": "id", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { @@ -132893,30 +133899,55 @@ "name": "apikey", "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 timezone user was created in", + "name": "timezone", + "type": "string" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, - {}, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" }, + {}, { "description": "the account type of the user", "name": "accounttype", "type": "integer" }, { - "description": "the user firstname", - "name": "firstname", + "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 domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { @@ -132925,16 +133956,25 @@ "type": "integer" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the account name of the user", + "name": "account", "type": "string" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + } ] }, { @@ -132943,42 +133983,49 @@ "name": "listLoadBalancerRules", "params": [ { - "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 by network ID the rule belongs to", + "description": "the ID of the virtual machine of the load balancer rule", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "virtualmachineid", + "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the availability zone ID", "length": 255, - "name": "tags", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the name of the load balancer rule", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "name", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the ID of the load balancer rule", + "description": "", "length": 255, - "name": "id", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", @@ -132994,13 +134041,6 @@ "required": false, "type": "string" }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -133010,64 +134050,79 @@ "type": "uuid" }, { - "description": "", + "description": "the ID of the load balancer rule", "length": 255, - "name": "page", + "name": "id", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the availability zone ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the public IP address ID 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": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the virtual machine of the load balancer rule", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "virtualmachineid", - "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the name of the load balancer rule", "length": 255, - "name": "listall", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the public IP address ID of the load balancer rule", "length": 255, - "name": "projectid", - "related": "", + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "list by network ID the rule belongs to", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the account of the load balancer rule", - "name": "account", + "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 public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { @@ -133075,13 +134130,8 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -133095,49 +134145,43 @@ "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", + "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 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", @@ -133149,48 +134193,55 @@ "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "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", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, + {}, { - "description": "the name of the load balancer", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" }, + {}, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the state of the rule", + "name": "state", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the protocol of the loadbalanacer rule", "name": "protocol", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { @@ -133199,39 +134250,28 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, - {}, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the public port", + "name": "publicport", "type": "string" } ] @@ -133252,25 +134292,25 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on 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" }, {} ] @@ -133281,10 +134321,10 @@ "name": "uploadSslCert", "params": [ { - "description": "SSL certificate", - "length": 16384, - "name": "certificate", - "required": true, + "description": "Certificate chain of trust", + "length": 2097152, + "name": "certchain", + "required": false, "type": "string" }, { @@ -133294,13 +134334,6 @@ "required": false, "type": "string" }, - { - "description": "account that will own the SSL certificate", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "Name for the uploaded certificate", "length": 255, @@ -133309,12 +134342,11 @@ "type": "string" }, { - "description": "Enables revocation checking for certificates", - "length": 255, - "name": "enabledrevocationcheck", - "required": false, - "since": "4.15", - "type": "boolean" + "description": "Private key", + "length": 16384, + "name": "privatekey", + "required": true, + "type": "string" }, { "description": "domain ID of the account owning the SSL certificate", @@ -133324,6 +134356,21 @@ "required": false, "type": "uuid" }, + { + "description": "SSL certificate", + "length": 16384, + "name": "certificate", + "required": true, + "type": "string" + }, + { + "description": "Enables revocation checking for certificates", + "length": 255, + "name": "enabledrevocationcheck", + "required": false, + "since": "4.15", + "type": "boolean" + }, { "description": "an optional project for the SSL certificate", "length": 255, @@ -133333,42 +134380,34 @@ "type": "uuid" }, { - "description": "Certificate chain of trust", - "length": 2097152, - "name": "certchain", + "description": "account that will own the SSL certificate", + "length": 255, + "name": "account", "required": false, "type": "string" - }, - { - "description": "Private key", - "length": 16384, - "name": "privatekey", - "required": true, - "type": "string" } ], "related": "", "response": [ { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "name", + "name": "name", "type": "string" }, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, { - "description": "account for the certificate", - "name": "account", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, - {}, { - "description": "certificate chain", - "name": "certchain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "certificate", @@ -133376,44 +134415,45 @@ "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" - }, - { - "description": "SSL certificate ID", - "name": "id", + "description": "the project name of the certificate", + "name": "project", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "certificate chain", + "name": "certchain", "type": "string" }, {}, { - "description": "the project name of the certificate", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, { - "description": "name", - "name": "name", + "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": "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", + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "account for the certificate", + "name": "account", "type": "string" } ] @@ -133424,26 +134464,33 @@ "name": "updateOauthProvider", "params": [ { - "description": "Secret Key pre-registered in the specific OAuth provider", + "description": "id of the OAuth provider to be updated", "length": 255, - "name": "secretkey", + "name": "id", + "related": "updateOauthProvider", + "required": true, + "type": "uuid" + }, + { + "description": "Client ID pre-registered in the specific OAuth provider", + "length": 255, + "name": "clientid", "required": false, "type": "string" }, { - "description": "Redirect URI pre-registered in the specific OAuth provider", + "description": "Secret Key pre-registered in the specific OAuth provider", "length": 255, - "name": "redirecturi", + "name": "secretkey", "required": false, "type": "string" }, { - "description": "id of the OAuth provider to be updated", + "description": "Description of the OAuth Provider", "length": 255, - "name": "id", - "related": "updateOauthProvider", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" }, { "description": "OAuth provider will be enabled or disabled based on this value", @@ -133453,16 +134500,9 @@ "type": "boolean" }, { - "description": "Description of the OAuth Provider", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, - { - "description": "Client ID pre-registered in the specific OAuth provider", + "description": "Redirect URI pre-registered in the specific OAuth provider", "length": 255, - "name": "clientid", + "name": "redirecturi", "required": false, "type": "string" } @@ -133470,28 +134510,23 @@ "related": "", "response": [ { - "description": "ID of the provider", - "name": "id", + "description": "Name of the provider", + "name": "name", "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the 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": "Name of the provider", - "name": "name", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, { @@ -133500,26 +134535,31 @@ "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" }, - {}, { - "description": "Description of the provider registered", - "name": "description", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, { - "description": "Name of the provider", - "name": "provider", + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" + }, + { + "description": "ID of the provider", + "name": "id", "type": "string" }, {}, + {}, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.19.0" @@ -133530,30 +134570,16 @@ "name": "createVpnCustomerGateway", "params": [ { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "ipsecpsk", + "name": "ikepolicy", "required": true, "type": "string" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", - "length": 255, - "name": "ikelifetime", - "required": false, - "type": "long" - }, - { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", - "length": 255, - "name": "esplifetime", - "required": false, - "type": "long" - }, - { - "description": "If DPD is enabled for VPN connection", + "description": "Force Encapsulation for NAT traversal", "length": 255, - "name": "dpd", + "name": "forceencap", "required": false, "type": "boolean" }, @@ -133565,13 +134591,6 @@ "since": "4.15.1", "type": "string" }, - { - "description": "IKE policy of the customer gateway", - "length": 255, - "name": "ikepolicy", - "required": true, - "type": "string" - }, { "description": "create site-to-site VPN customer gateway for the project", "length": 255, @@ -133582,25 +134601,25 @@ "type": "uuid" }, { - "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "cidrlist", - "required": true, - "type": "string" + "name": "ikelifetime", + "required": false, + "type": "long" }, { - "description": "name of this customer gateway", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "name", - "required": false, + "name": "ipsecpsk", + "required": true, "type": "string" }, { - "description": "Force Encapsulation for NAT traversal", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "forceencap", + "name": "esplifetime", "required": false, - "type": "boolean" + "type": "long" }, { "description": "ESP policy of the customer gateway", @@ -133610,20 +134629,33 @@ "type": "string" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "public ip address id of the customer gateway", "length": 255, - "name": "account", - "required": false, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "splitconnections", + "name": "cidrlist", + "required": true, + "type": "string" + }, + { + "description": "If DPD is enabled for VPN connection", + "length": 255, + "name": "dpd", "required": false, - "since": "4.15.1", "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 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, @@ -133633,78 +134665,81 @@ "type": "uuid" }, { - "description": "public ip address id of the customer gateway", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "gateway", - "required": true, + "name": "splitconnections", + "required": false, + "since": "4.15.1", + "type": "boolean" + }, + { + "description": "name of this customer gateway", + "length": 255, + "name": "name", + "required": false, "type": "string" } ], "related": "", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the project name", - "name": "project", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { @@ -133713,18 +134748,14 @@ "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" - }, - { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -133733,15 +134764,13 @@ "type": "integer" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, - {}, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { @@ -133750,13 +134779,24 @@ "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + {}, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" } ] @@ -133767,34 +134807,19 @@ "name": "createManagementNetworkIpRange", "params": [ { - "description": "The gateway for the management network.", + "description": "Specify if range is dedicated for CPVM and SSVM.", "length": 255, - "name": "gateway", - "required": true, - "type": "string" + "name": "forsystemvms", + "required": false, + "type": "boolean" }, { - "description": "The netmask for the management network.", + "description": "The gateway for the management network.", "length": 255, - "name": "netmask", + "name": "gateway", "required": true, "type": "string" }, - { - "description": "UUID of POD, where the IP range belongs to.", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "Specify if range is dedicated for CPVM and SSVM.", - "length": 255, - "name": "forsystemvms", - "required": false, - "type": "boolean" - }, { "description": "The ending IP address.", "length": 255, @@ -133809,26 +134834,31 @@ "required": true, "type": "string" }, + { + "description": "The netmask for the management network.", + "length": 255, + "name": "netmask", + "required": true, + "type": "string" + }, { "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan", "length": 255, "name": "vlan", "required": false, "type": "string" + }, + { + "description": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, { "description": "the name of the Pod", "name": "name", @@ -133838,30 +134868,20 @@ "description": "the capacity of the Pod", "name": "capacity", "response": [ - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, { "description": "the capacity name", "name": "name", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Zone name", + "name": "zonename", + "type": "string" }, { "description": "the Cluster ID", @@ -133869,9 +134889,9 @@ "type": "string" }, { - "description": "the Pod ID", - "name": "podid", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the capacity type", @@ -133879,65 +134899,39 @@ "type": "short" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "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 capacity currently in allocated", "name": "capacityallocated", "type": "long" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" } ], "type": "list" }, - { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" - }, - { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, - {}, - { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the gateway of the Pod", - "name": "gateway", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, {}, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, { "description": "the IP ranges for the Pod", "name": "ipranges", @@ -133948,41 +134942,82 @@ "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the gateway for the range", - "name": "gateway", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the gateway for the range", + "name": "gateway", "type": "string" } ], "type": "list" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" + }, + { + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Pod", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of the Pod", + "name": "gateway", + "type": "string" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, { @@ -133991,9 +135026,14 @@ "type": "list" }, { - "description": "the ID of the Pod", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + }, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" } ], "since": "4.11.0.0" @@ -134003,6 +135043,14 @@ "isasync": false, "name": "listCiscoNexusVSMs", "params": [ + { + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "length": 255, + "name": "clusterid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -134011,18 +135059,17 @@ "type": "integer" }, { - "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "clusterid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, @@ -134032,51 +135079,40 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, + {}, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, + {}, { "description": "control vlan id of the VSM", "name": "vsmctrlvlanid", "type": "int" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" }, { - "description": "device state", - "name": "vsmdevicestate", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { @@ -134085,25 +135121,19 @@ "type": "string" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", - "type": "string" - }, - {}, - { - "description": "device name", - "name": "vsmdevicename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", + "type": "string" }, { "description": "The Config State (Primary/Standby) of the VSM", @@ -134111,8 +135141,18 @@ "type": "string" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", + "type": "string" + }, + { + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" + }, + { + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" } ] @@ -134123,19 +135163,19 @@ "name": "addVpnUser", "params": [ { - "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "description": "username for the vpn user", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "name": "username", + "required": true, + "type": "string" }, { - "description": "an optional account for the vpn user. Must be used with domainId.", + "description": "add vpn user to the specific project", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "password for the username", @@ -134145,73 +135185,73 @@ "type": "string" }, { - "description": "add vpn user to the specific project", + "description": "an optional account for the vpn user. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "username for the vpn user", + "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" } ], "related": "", "response": [ + { + "description": "the username of the vpn user", + "name": "username", + "type": "string" + }, { "description": "the account of the remote access vpn", "name": "account", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" + "description": "the 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 vpn userID", + "name": "id", "type": "string" }, - {}, { - "description": "the username of the vpn user", - "name": "username", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" - }, + {}, { "description": "the project id of the vpn", "name": "projectid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", + "type": "string" }, { - "description": "the vpn userID", - "name": "id", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", - "name": "state", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" } ] @@ -134232,50 +135272,55 @@ "related": "", "response": [ { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", - "type": "string" - }, - { - "description": "the removal timestamp for this annotation", - "name": "removed", + "description": "the creation timestamp for this annotation", + "name": "created", "type": "date" }, {}, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" - }, { "description": "the contents of the annotation", "name": "annotation", "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + { + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, + {}, { "description": "the (uu)id of the annotation", "name": "id", "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the type of the annotated entity", + "name": "entitytype", + "type": "string" + }, + { + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" + }, + { + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { @@ -134283,11 +135328,6 @@ "name": "adminsonly", "type": "boolean" }, - { - "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", @@ -134302,10 +135342,17 @@ "name": "addBaremetalHost", "params": [ { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "the host URL", "length": 255, - "name": "username", - "required": false, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "hypervisor type of the host", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" }, { @@ -134316,18 +135363,24 @@ "type": "string" }, { - "description": "the Zone ID for the host", + "description": "ip address intentionally allocated to this host after provisioning", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "ipaddress", + "required": false, + "type": "string" }, { - "description": "the host URL", + "description": "the cluster name for the host", "length": 255, - "name": "url", - "required": true, + "name": "clustername", + "required": false, + "type": "string" + }, + { + "description": "Allocation state of this Host for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, { @@ -134339,26 +135392,20 @@ "type": "uuid" }, { - "description": "the Pod ID for the host", + "description": "the Zone ID for the host", "length": 255, - "name": "podid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "hypervisor type of the host", + "description": "the Pod ID for the host", "length": 255, - "name": "hypervisor", + "name": "podid", + "related": "", "required": true, - "type": "string" - }, - { - "description": "ip address intentionally allocated to this host after provisioning", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" + "type": "uuid" }, { "description": "list of tags to be added to the host", @@ -134368,16 +135415,9 @@ "type": "list" }, { - "description": "the cluster name for the host", - "length": 255, - "name": "clustername", - "required": false, - "type": "string" - }, - { - "description": "Allocation state of this Host for allocation of new resources", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "allocationstate", + "name": "username", "required": false, "type": "string" } @@ -134385,209 +135425,136 @@ "related": "", "response": [ { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, + {}, { "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", "name": "memorytotal", "type": "long" }, - {}, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "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 admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "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", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, + {}, { - "description": "the name of the host", - "name": "name", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the host version", - "name": "version", - "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", + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "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": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "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 cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { "description": "events available for the host", "name": "events", "type": "string" }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" - }, { "description": "the last time this host was annotated", "name": "lastannotated", "type": "date" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { "description": "comma-separated list of tags for the host", @@ -134595,165 +135562,238 @@ "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "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": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, - {}, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "Host 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": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the host 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 amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "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 vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the amount of the host's 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 cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + { + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" } ] }, @@ -134762,14 +135802,6 @@ "isasync": false, "name": "deleteProjectRolePermission", "params": [ - { - "description": "ID of the project role permission to be deleted", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "ID of the project where the project role permission is to be deleted", "length": 255, @@ -134777,41 +135809,9 @@ "related": "", "required": true, "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} - ], - "since": "4.15.0" - }, - { - "description": "Deletes a role permission", - "isasync": false, - "name": "deleteRolePermission", - "params": [ - { - "description": "ID of the role permission", + "description": "ID of the project role permission to be deleted", "length": 255, "name": "id", "related": "", @@ -134826,24 +135826,24 @@ "type": "boolean" }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], - "since": "4.9.0" + "since": "4.15.0" }, { "description": "Updates the quarantine end date for the given public IP address.", @@ -134857,13 +135857,6 @@ "required": true, "type": "date" }, - { - "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - }, { "description": "The ID of the public IP address in active quarantine.", "length": 255, @@ -134871,45 +135864,41 @@ "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" } ], "related": "", "response": [ - {}, - { - "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", - "type": "string" - }, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "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 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" }, + {}, { "description": "End date for the quarantine.", "name": "enddate", "type": "date" }, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, { @@ -134922,19 +135911,70 @@ "name": "id", "type": "string" }, + { + "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": "When the quarantine was removed.", "name": "removed", "type": "date" }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], "since": "4.19" }, + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.9.0" + }, { "description": "Update VM Schedule.", "isasync": false, @@ -134948,45 +135988,45 @@ "type": "date" }, { - "description": "Name of the schedule", + "description": "ID of VM schedule", "length": 255, - "name": "description", - "required": false, - "type": "string" + "name": "id", + "related": "updateVMSchedule", + "required": true, + "type": "uuid" }, { - "description": "Enable VM schedule", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "enabled", + "name": "enddate", "required": false, - "type": "boolean" + "type": "date" }, { - "description": "ID of VM schedule", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, - "name": "id", - "related": "updateVMSchedule", - "required": true, - "type": "uuid" + "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'", + "description": "Name of the schedule", "length": 255, - "name": "schedule", + "name": "description", "required": false, "type": "string" }, { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "description": "Enable VM schedule", "length": 255, - "name": "enddate", + "name": "enabled", "required": false, - "type": "date" + "type": "boolean" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "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": "timezone", + "name": "schedule", "required": false, "type": "string" } @@ -134994,23 +136034,40 @@ "related": "", "response": [ { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Description of VM schedule", + "name": "description", + "type": "string" + }, + {}, + { + "description": "Cron formatted VM schedule", + "name": "schedule", + "type": "string" }, { "description": "Timezone of the schedule", "name": "timezone", "type": "string" }, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + }, + {}, { "description": "Action", "name": "action", "type": "action" }, { - "description": "the ID of VM schedule", - "name": "id", + "description": "ID of virtual machine", + "name": "virtualmachineid", "type": "string" }, { @@ -135019,13 +136076,8 @@ "type": "date" }, { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" - }, - { - "description": "Description of VM schedule", - "name": "description", + "description": "the ID of VM schedule", + "name": "id", "type": "string" }, { @@ -135034,26 +136086,14 @@ "type": "integer" }, { - "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": "Date after which the schedule becomes inactive", - "name": "enddate", + "description": "Date from which the schedule is active", + "name": "startdate", "type": "date" }, - {}, { - "description": "ID of virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" } ], "since": "4.19.0" @@ -135061,80 +136101,64 @@ { "description": "Updates a template to VNF template or attributes of a VNF template.", "isasync": false, - "name": "updateVnfTemplate", - "params": [ - { - "description": "the ID of the OS type that best represents the OS of this image.", - "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "sort key of the template, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, + "name": "updateVnfTemplate", + "params": [ { - "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", "length": 255, - "name": "cleanupvnfdetails", + "name": "cleanupdetails", "required": false, "type": "boolean" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "bootable", + "name": "templatetype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if the image supports the password reset feature; default is false", + "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": "passwordenabled", + "name": "vnfdetails", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "vnfdetails", + "name": "details", "required": false, "type": "map" }, { - "description": "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": "optional boolean field, which indicates if VNF nics will be cleaned up or not", "length": 255, - "name": "cleanupdetails", + "name": "cleanupvnfnics", "required": false, "type": "boolean" }, { - "description": "the ID of the image file", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "requireshvm", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, + { + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, { "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, @@ -135143,32 +136167,34 @@ "type": "boolean" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "details", + "name": "bootable", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", + "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", "length": 255, - "name": "vnfnics", + "name": "cleanupvnfdetails", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "the format for the image", + "description": "the ID of the image file", "length": 255, - "name": "format", - "required": false, - "type": "string" + "name": "id", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "the ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "isdynamicallyscalable", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "true if the template supports the sshkey upload feature; default is false", @@ -135177,13 +136203,6 @@ "required": false, "type": "boolean" }, - { - "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 name of the image file", "length": 255, @@ -135192,154 +136211,64 @@ "type": "string" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "the format for the image", "length": 255, - "name": "templatetype", + "name": "format", "required": false, "type": "string" - } - ], - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", - "response": [ - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - {}, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "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 date this template was created", - "name": "created", - "type": "date" + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "true if template requires HVM enabled, false otherwise", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "length": 255, "name": "requireshvm", + "required": false, "type": "boolean" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "the template ID", - "name": "id", - "type": "string" - }, + } + ], + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", + "response": [ { - "description": "the project name of the template", - "name": "project", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, { "description": "the date this template was removed", "name": "removed", "type": "date" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, - { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", + "description": "the project name of the template", + "name": "project", "type": "string" }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, { "description": "the template name", "name": "name", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { @@ -135352,76 +136281,108 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "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 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": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, + {}, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "the id of userdata linked to this template", + "name": "userdataid", + "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": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { @@ -135430,14 +136391,14 @@ "type": "resourceiconresponse" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { "description": "the format of the template.", @@ -135449,34 +136410,49 @@ "name": "zoneid", "type": "string" }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, { "description": "true if this template is a featured template, false otherwise", "name": "isfeatured", "type": "boolean" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { @@ -135485,45 +136461,109 @@ "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, { "description": "the name of userdata linked to this template", "name": "userdataname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, - {}, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the template display text", + "name": "displaytext", "type": "string" }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" } ], "since": "4.19.0" @@ -135534,18 +136574,18 @@ "name": "listConfigurationGroups", "params": [ { - "description": "lists configuration group by group name", + "description": "List by keyword", "length": 255, - "name": "group", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "lists configuration group by group name", "length": 255, - "name": "page", + "name": "group", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -135555,40 +136595,29 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "the precedence of the configuration group", - "name": "precedence", - "type": "long" + "description": "the description of the configuration group", + "name": "description", + "type": "string" }, + {}, { - "description": "the subgroups of the configuration group", - "name": "subgroup", - "response": [ - { - "description": "the precedence of the configuration subgroup", - "name": "precedence", - "type": "long" - }, - { - "description": "the name of the configuration subgroup", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the description of the configuration group", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -135598,15 +136627,26 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the precedence of the configuration group", + "name": "precedence", + "type": "long" }, - {}, { - "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 name of the configuration subgroup", + "name": "name", + "type": "string" + }, + { + "description": "the precedence of the configuration subgroup", + "name": "precedence", + "type": "long" + } + ], + "type": "list" } ], "since": "4.18.0" @@ -135625,15 +136665,14 @@ } ], "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 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" }, { @@ -135646,7 +136685,8 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -135655,24 +136695,16 @@ "name": "updateVPCOffering", "params": [ { - "description": "the id of the VPC offering", - "length": 255, - "name": "id", - "related": "updateVPCOffering", - "required": true, - "type": "uuid" - }, - { - "description": "sort key of the VPC offering, integer", + "description": "the name of the VPC offering", "length": 255, - "name": "sortkey", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the name of the VPC offering", + "description": "update state for the VPC offering; supported states - Enabled/Disabled", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, @@ -135685,11 +136717,11 @@ "type": "string" }, { - "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "description": "sort key of the VPC offering, integer", "length": 255, - "name": "state", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { "description": "the display text of the VPC offering", @@ -135698,6 +136730,14 @@ "required": false, "type": "string" }, + { + "description": "the id of the VPC offering", + "length": 255, + "name": "id", + "related": "updateVPCOffering", + "required": true, + "type": "uuid" + }, { "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", "length": 4096, @@ -135708,32 +136748,32 @@ ], "related": "", "response": [ - {}, { "description": "the internet protocol of the vpc offering", "name": "internetprotocol", "type": "string" }, { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "description": "the id of the vpc offering", + "name": "id", "type": "string" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the name of the vpc offering", - "name": "name", - "type": "string" + "description": " indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" }, + {}, { "description": "the list of supported services", "name": "service", @@ -135743,34 +136783,34 @@ "name": "provider", "response": [ { - "description": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "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": "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", @@ -135790,13 +136830,13 @@ "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" } ], @@ -135811,44 +136851,38 @@ "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the vpc offering", - "name": "id", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, - {}, { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the name of the vpc offering", + "name": "name", "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { @@ -135857,10 +136891,16 @@ "type": "boolean" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ] }, { @@ -135868,14 +136908,6 @@ "isasync": true, "name": "updateRemoteAccessVpn", "params": [ - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, { "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, @@ -135891,14 +136923,22 @@ "related": "updateRemoteAccessVpn", "required": true, "type": "uuid" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" } ], "related": "", "response": [ { - "description": "the range of ips to allocate to the clients", - "name": "iprange", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -135906,66 +136946,66 @@ "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, {}, { - "description": "the state of the rule", - "name": "state", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, - {}, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, + {}, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "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 public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account of the remote access vpn", + "name": "account", + "type": "string" } ], "since": "4.4" @@ -135985,27 +137025,27 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the description of the user two factor authenticator provider", - "name": "description", - "type": "string" - }, { "description": "the user two factor authenticator provider name", "name": "name", "type": "string" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the description of the user two factor authenticator provider", + "name": "description", + "type": "string" } ], "since": "4.18.0" @@ -136015,14 +137055,6 @@ "isasync": true, "name": "scaleVirtualMachine", "params": [ - { - "description": "New maximum number of IOPS for the custom disk offering", - "length": 255, - "name": "maxiops", - "required": false, - "since": "4.17", - "type": "long" - }, { "description": "New minimum number of IOPS for the custom disk offering", "length": 255, @@ -136062,6 +137094,14 @@ "since": "4.17", "type": "boolean" }, + { + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.17", + "type": "long" + }, { "description": "the ID of the service offering for the virtual machine", "length": 255, @@ -136072,11 +137112,7 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -136087,13 +137123,17 @@ "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" - }, - {} + } ] }, { @@ -136130,65 +137170,238 @@ "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", "response": [ { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "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 ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "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 account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, { "description": "the group ID of the virtual machine", "name": "groupid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "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 name of the host for the virtual machine", "name": "hostname", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + {}, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the project name of the vm", + "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 name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { "description": "the VM's disk write in KiB", @@ -136196,160 +137409,108 @@ "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "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 ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the virtual machine", + "name": "id", "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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "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 state of the virtual machine", + "name": "state", "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": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the 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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { @@ -136362,8 +137523,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -136376,141 +137542,153 @@ "name": "domainid", "type": "string" }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "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 control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the 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 name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project 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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" + }, { "description": "the list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", "type": "set" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the 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": "security group name", - "name": "securitygroupname", + "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", @@ -136518,8 +137696,13 @@ "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -136527,108 +137710,98 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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 ID of the domain associated with the tag", - "name": "domainid", + "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 protocol of the security group rule", - "name": "protocol", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" } ], "type": "set" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -136637,18 +137810,8 @@ "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -136656,13 +137819,18 @@ "name": "account", "type": "string" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -136671,209 +137839,83 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the 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": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, { "description": "the number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" } ], "type": "set" }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, { "description": "the ID of the availability zone for the virtual machine", "name": "zoneid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, + {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { @@ -136882,70 +137924,43 @@ "type": "integer" }, { - "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 account associated with the virtual machine", - "name": "account", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - {}, - {}, { "description": "Os type ID of the virtual machine", "name": "guestosid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the disk 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" }, { @@ -136954,43 +137969,38 @@ "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the ID of the nic", - "name": "id", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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", + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", @@ -137003,53 +138013,43 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the type of the nic", + "name": "type", "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": "Type of adapter if available", - "name": "adaptertype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -137058,14 +138058,14 @@ "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { "description": "the isolated private VLAN type if available", @@ -137073,23 +138073,18 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -137098,67 +138093,112 @@ "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "name": "macaddress", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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" } ], "type": "set" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the ID of the 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 AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "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 field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" } ] }, @@ -137175,14 +138215,6 @@ "since": "4.4", "type": "boolean" }, - { - "description": "the ID of the egress firewall rule", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -137190,13 +138222,68 @@ "required": false, "since": "4.4", "type": "string" + }, + { + "description": "the ID of the egress firewall rule", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + {}, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "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 state of the rule", + "name": "state", + "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" }, { @@ -137204,23 +138291,23 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -137234,8 +138321,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -137244,66 +138336,31 @@ "type": "string" }, { - "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" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, { - "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" }, { @@ -137311,28 +138368,11 @@ "name": "ipaddress", "type": "string" }, - {}, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", "name": "destcidrlist", "type": "string" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - {} + } ], "since": "4.4" }, @@ -137341,13 +138381,6 @@ "isasync": false, "name": "listOsCategories", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -137356,11 +138389,12 @@ "type": "integer" }, { - "description": "", + "description": "list os category by name", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "since": "3.0.1", + "type": "string" }, { "description": "list Os category by id", @@ -137371,21 +138405,22 @@ "type": "uuid" }, { - "description": "list os category by name", + "description": "", "length": 255, - "name": "name", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, - "since": "3.0.1", "type": "string" } ], "related": "", "response": [ - { - "description": "the ID of the OS category", - "name": "id", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", @@ -137394,13 +138429,18 @@ }, {}, { - "description": "the name of the OS category", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the OS category", + "name": "id", + "type": "string" + }, + { + "description": "the name of the OS category", + "name": "name", "type": "string" } ] @@ -137411,32 +138451,32 @@ "name": "listServiceOfferings", "params": [ { - "description": "", + "description": "the CPU number that listed offerings must support", "length": 255, - "name": "page", + "name": "cpunumber", "required": false, + "since": "4.15", "type": "integer" }, { - "description": "the RAM memory that listed offering must support", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "memory", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.15", - "type": "integer" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the CPU number that listed offerings must support", + "description": "the RAM memory that listed offering must support", "length": 255, - "name": "cpunumber", + "name": "memory", "required": false, "since": "4.15", "type": "integer" @@ -137448,6 +138488,13 @@ "required": false, "type": "string" }, + { + "description": "is this a system vm offering", + "length": 255, + "name": "issystem", + "required": false, + "type": "boolean" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -137456,13 +138503,20 @@ "type": "string" }, { - "description": "the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "virtualmachineid", - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "id of zone disk offering is associated with", "length": 255, @@ -137473,27 +138527,25 @@ "type": "uuid" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "the CPU speed that listed offerings must support", "length": 255, - "name": "storagetype", + "name": "cpuspeed", "required": false, - "since": "4.19", - "type": "string" + "since": "4.15", + "type": "integer" }, { - "description": "ID of the service offering", + "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", "length": 255, - "name": "id", - "related": "updateServiceOffering,listServiceOfferings", + "name": "systemvmtype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the CPU speed that listed offerings must support", + "description": "", "length": 255, - "name": "cpuspeed", + "name": "pagesize", "required": false, - "since": "4.15", "type": "integer" }, { @@ -137505,33 +138557,27 @@ "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\".", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "systemvmtype", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "is this a system vm offering", + "description": "the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.", "length": 255, - "name": "issystem", + "name": "virtualmachineid", + "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "ID of the service offering", "length": 255, - "name": "pagesize", + "name": "id", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "name of the service offering", @@ -137541,25 +138587,29 @@ "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "isrecursive", + "name": "storagetype", "required": false, - "type": "boolean" + "since": "4.19", + "type": "string" } ], "related": "updateServiceOffering", "response": [ { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the date this service offering was created", + "name": "created", + "type": "date" + }, + { + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { @@ -137568,175 +138618,155 @@ "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": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "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 max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, + {}, + {}, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the tags for the service offering", + "name": "storagetags", + "type": "string" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", "type": "boolean" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, - { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - {}, { "description": "the storage type for this service offering", "name": "storagetype", "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, - { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" - }, { "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "name": "cacheMode", "type": "string" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", "type": "integer" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", + "description": "the ha support in the service offering", + "name": "offerha", "type": "boolean" }, { - "description": "is this a system vm offering", - "name": "issystem", - "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": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" - }, - { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "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 date this service offering was created", - "name": "created", - "type": "date" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", - "type": "boolean" + "description": "the name of the service offering", + "name": "name", + "type": "string" }, { - "description": "the id of the service offering", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, - {}, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", + "description": "Root disk size in GB", + "name": "rootdisksize", "type": "long" }, { @@ -137745,23 +138775,23 @@ "type": "integer" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the id of the service offering", + "name": "id", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { @@ -137770,59 +138800,69 @@ "type": "boolean" }, { - "description": "the name of the service offering", - "name": "name", + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", + "description": "is this a default system vm offering", + "name": "defaultuse", "type": "boolean" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" } ] }, @@ -137832,41 +138872,41 @@ "name": "importVm", "params": [ { - "description": "the name of the instance as it is known to the hypervisor", + "description": "(only for importing migrated VMs from Vmware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", "length": 255, - "name": "name", - "required": true, + "name": "vcenter", + "required": false, "type": "string" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "description": "import instance to the domain specified", "length": 255, - "name": "datadiskofferinglist", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "migrateallowed", + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the cluster ID", + "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": "clusterid", - "related": "", - "required": true, - "type": "uuid" + "name": "forced", + "required": false, + "type": "boolean" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) optional - the host to perform the virt-v2v migration from VMware to KVM.", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "convertinstancehostid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Host where local disk is located", @@ -137877,46 +138917,49 @@ "type": "uuid" }, { - "description": "the password for the host", + "description": "VM nic to ip address mapping using keys nic, ip4Address", "length": 255, - "name": "password", + "name": "nicipaddresslist", "required": false, - "type": "string" + "type": "map" }, { - "description": "VM nic to network id mapping using keys nic and network", + "description": "(only for importing migrated VMs from Vmware to KVM) UUID of a linked existing vCenter", "length": 255, - "name": "nicnetworklist", + "name": "existingvcenterid", + "related": "", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "Source location for Import", + "description": "the service offering for the virtual machine", "length": 255, - "name": "importsource", + "name": "serviceofferingid", + "related": "updateServiceOffering", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Temp Path on external host for disk image copy", + "description": "the username for the host", "length": 255, - "name": "temppath", + "name": "username", "required": false, "type": "string" }, { - "description": "the username for the host", + "description": "path of the disk image", "length": 255, - "name": "username", + "name": "diskpath", "required": false, "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "(only for importing migrated VMs from Vmware to KVM) optional - the host to perform the virt-v2v migration from VMware to KVM.", "length": 255, - "name": "account", + "name": "convertinstancehostid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the network ID", @@ -137927,116 +138970,121 @@ "type": "uuid" }, { - "description": "Shared storage pool where disk is located", + "description": "(only for importing migrated VMs from Vmware to KVM) Name of VMware datacenter.", "length": 255, - "name": "storageid", - "related": "", + "name": "datacentername", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the zone ID", + "description": "the cluster ID", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "clusterid", + "related": "", "required": true, "type": "uuid" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "nicipaddresslist", + "name": "datadiskofferinglist", "required": false, "type": "map" }, { - "description": "the host name or IP address", + "description": "(only for importing migrated VMs from Vmware to KVM) Name of VMware cluster.", "length": 255, - "name": "host", + "name": "clustername", "required": false, "type": "string" }, { - "description": "the service offering for the virtual machine", + "description": "the display name of the instance", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" + "name": "displayname", + "required": false, + "type": "string" }, { - "description": "the host name of the instance", + "description": "Temp Path on external host for disk image copy", "length": 255, - "name": "hostname", + "name": "temppath", "required": false, "type": "string" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) Name of VMware cluster.", + "description": "import instance for the project", "length": 255, - "name": "clustername", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "the password for the host", "length": 255, - "name": "vcenter", + "name": "password", "required": false, "type": "string" }, { - "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", + "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", "length": 255, - "name": "forced", + "name": "migrateallowed", "required": false, "type": "boolean" }, { - "description": "the ID of the template for the virtual machine", + "description": "used to specify the custom parameters.", "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "hypervisor type of the host", + "description": "Shared storage pool where disk is located", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "storageid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "used to specify the custom parameters.", + "description": "VM nic to network id mapping using keys nic and network", "length": 255, - "name": "details", + "name": "nicnetworklist", "required": false, "type": "map" }, { - "description": "import instance for the project", + "description": "the host name of the instance", "length": 255, - "name": "projectid", - "related": "", + "name": "hostname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "import instance to the domain specified", + "description": "hypervisor type of the host", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) Name of VMware datacenter.", + "description": "the name of the instance as it is known to the hypervisor", "length": 255, - "name": "datacentername", - "required": false, + "name": "name", + "required": true, "type": "string" }, + { + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { "description": "(only for importing migrated VMs from Vmware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.", "length": 255, @@ -138046,16 +139094,16 @@ "type": "uuid" }, { - "description": "the display name of the instance", + "description": "Source location for Import", "length": 255, - "name": "displayname", - "required": false, + "name": "importsource", + "required": true, "type": "string" }, { - "description": "path of the disk image", + "description": "the host name or IP address", "length": 255, - "name": "diskpath", + "name": "host", "required": false, "type": "string" }, @@ -138065,486 +139113,100 @@ "name": "hostip", "required": false, "type": "string" - }, - { - "description": "(only for importing migrated VMs from Vmware to KVM) UUID of a linked existing vCenter", - "length": 255, - "name": "existingvcenterid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", - "response": [ - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "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": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "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": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - {}, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - {}, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "instance 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", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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 pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, + "response": [ { - "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 memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "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", + "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 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": "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", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "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", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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 key name", + "name": "key", "type": "string" }, { @@ -138553,157 +139215,92 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { "description": "security group name", "name": "securitygroupname", "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, { "description": "the 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 ID of the security group", - "name": "id", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -138712,28 +139309,28 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -138742,107 +139339,367 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" } ], "type": "set" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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", + "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", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + {}, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ { - "description": "the ID of the nic", - "name": "id", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "the isolated private VLAN type if available", @@ -138850,13 +139707,23 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -138865,122 +139732,241 @@ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the gateway of the nic", + "name": "gateway", + "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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, { "description": "the ID of the corresponding network", "name": "networkid", "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "Id of the 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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" } ], "type": "set" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "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", + "type": "string" + }, + {}, + { + "description": "the group name of the virtual machine", + "name": "group", + "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 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 ID of the virtual machine", - "name": "id", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, + {}, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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 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": "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 id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the account associated with the virtual machine", @@ -138988,9 +139974,9 @@ "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { "description": "the write (IO) of disk on the VM", @@ -138998,43 +139984,48 @@ "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 userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the 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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { @@ -139043,69 +140034,118 @@ "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "Vm details in key/value pairs.", "name": "details", "type": "map" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, - {}, { - "description": "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 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 template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, { "description": "the user's name who deployed the virtual machine", "name": "username", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" } ], @@ -139117,28 +140157,23 @@ "name": "removeFromGlobalLoadBalancerRule", "params": [ { - "description": "the list load balancer rules that will be assigned to global load balancer rule", + "description": "The ID of the load balancer rule", "length": 255, - "name": "loadbalancerrulelist", + "name": "id", "related": "", "required": true, - "type": "list" + "type": "uuid" }, { - "description": "The ID of the load balancer rule", + "description": "the list load balancer rules that will be assigned to global load balancer rule", "length": 255, - "name": "id", + "name": "loadbalancerrulelist", "related": "", "required": true, - "type": "uuid" + "type": "list" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -139149,13 +140184,18 @@ "name": "displaytext", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -139166,14 +140206,14 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -139187,23 +140227,23 @@ ], "related": "", "response": [ + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - } + {} ] }, { @@ -139212,41 +140252,36 @@ "name": "listCapacity", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "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.", + "description": "", "length": 255, - "name": "type", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "Sort the results. Available values: Usage", + "description": "lists capacity by the Zone ID", "length": 255, - "name": "sortby", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "3.0.0", - "type": "string" + "type": "uuid" }, { - "description": "lists capacity by the Zone ID", + "description": "lists capacity by the Cluster ID", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "clusterid", + "related": "", "required": false, + "since": "3.0.0", "type": "uuid" }, { - "description": "", + "description": "recalculate capacities and fetch the latest", "length": 255, - "name": "page", + "name": "fetchlatest", "required": false, - "type": "integer" + "since": "3.0.0", + "type": "boolean" }, { "description": "lists capacity by the Pod ID", @@ -139257,41 +140292,46 @@ "type": "uuid" }, { - "description": "lists capacity by the Cluster ID", + "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": "clusterid", - "related": "", + "name": "type", + "required": false, + "type": "integer" + }, + { + "description": "Sort the results. Available values: Usage", + "length": 255, + "name": "sortby", "required": false, "since": "3.0.0", - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "recalculate capacities and fetch the latest", + "description": "", "length": 255, - "name": "fetchlatest", + "name": "page", "required": false, - "since": "3.0.0", - "type": "boolean" + "type": "integer" } ], "related": "", "response": [ { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -139299,62 +140339,62 @@ "type": "string" }, { - "description": "the capacity name", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Pod name", + "name": "podname", "type": "string" }, + {}, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" }, + {}, { "description": "the Zone ID", "name": "zoneid", "type": "string" }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, { "description": "the Zone name", "name": "zonename", "type": "string" }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, { "description": "the Pod ID", "name": "podid", "type": "string" }, - {}, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, { - "description": "the Pod name", - "name": "podname", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - {} + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + } ] }, { @@ -139379,14 +140419,6 @@ "since": "4.4", "type": "string" }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", - "required": true, - "type": "uuid" - }, { "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, @@ -139396,19 +140428,27 @@ "type": "uuid" }, { - "description": "Boot into hardware setup menu or not", + "description": "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process.", "length": 255, - "name": "bootintosetup", + "name": "considerlasthost", "required": false, - "since": "4.15.0.0", + "since": "4.18.0", "type": "boolean" }, { - "description": "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process.", + "description": "The ID of the virtual machine", "length": 255, - "name": "considerlasthost", + "name": "id", + "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", + "required": true, + "type": "uuid" + }, + { + "description": "Boot into hardware setup menu or not", + "length": 255, + "name": "bootintosetup", "required": false, - "since": "4.18.0", + "since": "4.15.0.0", "type": "boolean" }, { @@ -139423,579 +140463,328 @@ "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", "response": [ { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the 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 project name of the vm", - "name": "project", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "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": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "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": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, { "description": "the read (IO) of disk on the VM", "name": "diskioread", "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "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 ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "id of the resource", + "name": "resourceid", "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", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { "description": "Os type ID of the virtual machine", "name": "guestosid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, + {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the 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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "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 type of the affinity group", + "name": "type", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", + "description": "the project name of the affinity group", "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "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 domain name of the affinity group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { @@ -140003,37 +140792,32 @@ "name": "securitygroup", "response": [ { - "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 ID of the security group", - "name": "domainid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -140042,117 +140826,112 @@ "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "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 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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -140161,23 +140940,23 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -140186,32 +140965,67 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the protocol of the security group rule", "name": "protocol", @@ -140222,18 +141036,8 @@ "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", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -140242,23 +141046,23 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -140270,435 +141074,499 @@ "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": "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the description of the security group", + "name": "description", "type": "string" }, { "description": "the project id of the group", "name": "projectid", "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + {}, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the 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 amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, + {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "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 domain ID of the affinity group", - "name": "domainid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the affinity group", + "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 the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the 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": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the type of the affinity group", + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the 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" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], "type": "set" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, - {}, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - } - ] - }, - { - "description": "Updates a service offering.", - "isasync": false, - "name": "updateServiceOffering", - "params": [ - { - "description": "the display text of the service offering to be updated", - "length": 255, - "name": "displaytext", - "required": false, + "description": "State of the Service from LB rule", + "name": "servicestate", "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": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the host tag for this service offering.", - "length": 255, - "name": "hosttags", - "required": false, - "since": "4.16", + "description": "OS name of the vm", + "name": "osdisplayname", "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 type of the template for the virtual machine", + "name": "templatetype", "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": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the ID of the service offering to be updated", - "length": 255, - "name": "id", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" - }, - { - "description": "the name of the service offering to be updated", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "sort key of the service offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, - {}, - { - "description": "the memory in MB", - "name": "memory", - "type": "integer" - }, - { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" - }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" - }, - { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "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 zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" - }, - {}, - { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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 name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" - }, + } + ] + }, + { + "description": "Updates a service offering.", + "isasync": false, + "name": "updateServiceOffering", + "params": [ { - "description": "the host tag for the service offering", + "description": "the host tag for this service offering.", + "length": 255, "name": "hosttags", + "required": false, + "since": "4.16", "type": "string" }, { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" - }, - { - "description": "the date this service offering was created", - "name": "created", - "type": "date" - }, - { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the display text of the service offering to be updated", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "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": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "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 ID of the service offering to be updated", + "length": 255, + "name": "id", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" }, { - "description": "the name of the service offering", + "description": "the name of the service offering to be updated", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "the id of the service offering", - "name": "id", - "type": "string" - }, - { - "description": "the storage type for this service offering", - "name": "storagetype", + "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": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "sort key of the service offering, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { "description": "length (in seconds) of the burst", @@ -140706,68 +141574,48 @@ "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 service offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", "type": "boolean" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "Root disk size in GB", + "name": "rootdisksize", "type": "long" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" - }, - { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", "type": "long" }, { @@ -140776,9 +141624,9 @@ "type": "boolean" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { "description": "the vsphere storage policy tagged to the service offering in case of VMware", @@ -140786,253 +141634,131 @@ "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" - } - ] - }, - { - "description": "Stops a virtual machine.", - "isasync": true, - "name": "stopVirtualMachine", - "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", - "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", - "response": [ - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - {}, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "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": "device ID of the root volume", - "name": "rootdeviceid", + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "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 write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "is this a default system vm offering", + "name": "defaultuse", "type": "boolean" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the 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": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, + {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the service offering", + "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - {}, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the id of the service offering", + "name": "id", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, + {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "is true if the offering is customized", + "name": "iscustomized", "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" }, { "description": "true if the entity/resource has annotations", @@ -141040,320 +141766,277 @@ "type": "boolean" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the ha support in the service offering", + "name": "offerha", "type": "boolean" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - } - ], - "type": "set" + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + } + ] + }, + { + "description": "Stops a virtual machine.", + "isasync": true, + "name": "stopVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", + "required": true, + "type": "uuid" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "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", + "response": [ + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + {}, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "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 description of the security group", - "name": "description", + "description": "the ID of the security group", + "name": "id", "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", + "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" }, { @@ -141362,8 +142045,8 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -141376,33 +142059,33 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -141411,93 +142094,98 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], "type": "set" }, + { + "description": "the account owning the security group", + "name": "account", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the 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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -141506,47 +142194,27 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "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 account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", @@ -141558,20 +142226,10 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "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", @@ -141581,14 +142239,19 @@ "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -141597,18 +142260,8 @@ "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", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -141622,27 +142275,47 @@ "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": "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" @@ -141652,22 +142325,32 @@ "name": "virtualmachineids", "type": "set" }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, { "description": "the domain name of the security group", "name": "domain", "type": "string" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -141676,8 +142359,13 @@ "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -141686,18 +142374,100 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -141706,109 +142476,302 @@ "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the 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": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "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 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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the 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 vm to which the nic belongs", + "name": "virtualmachineid", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "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 the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "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 nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "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 group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, + {}, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "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 backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, - {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "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": "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": "device type of the root volume", - "name": "rootdevicetype", + "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", + "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", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { @@ -141817,8 +142780,13 @@ "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { @@ -141827,24 +142795,96 @@ "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" } ] }, @@ -141854,10 +142894,18 @@ "name": "createNetworkACLList", "params": [ { - "description": "Name of the network ACL list", + "description": "an optional field, whether to the display the list to the end user or not", "length": 255, - "name": "name", - "required": true, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "Description of the network ACL list", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { @@ -141869,26 +142917,29 @@ "type": "uuid" }, { - "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": "Description of the network ACL list", + "description": "Name of the network ACL list", "length": 255, - "name": "description", - "required": false, + "name": "name", + "required": true, "type": "string" } ], "related": "", "response": [ { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "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", "type": "string" }, { @@ -141897,13 +142948,8 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", "type": "string" }, { @@ -141921,15 +142967,9 @@ "name": "vpcid", "type": "string" }, - { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {}, {} ] } ], - "count": 754 + "count": 765 } From 2abb2b5f33046768459e30f132260c2b7280219d Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Tue, 23 Jul 2024 20:32:31 -0500 Subject: [PATCH 14/22] add missing quota api functions to layout.go --- generate/layout.go | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/generate/layout.go b/generate/layout.go index 5dd2ee8..5e76e63 100644 --- a/generate/layout.go +++ b/generate/layout.go @@ -484,7 +484,16 @@ var layout = apiInfo{ "revokeSecurityGroupIngress", }, "QuotaService": { + "quotaBalance", + "quotaCredits", "quotaIsEnabled", + "quotaStatement", + "quotaSummary", + "quotaTariffCreate", + "quotaTariffDelete", + "quotaTariffList", + "quotaTariffUpdate", + "quotaUpdate", }, "PodService": { "createPod", From 47ab50dc17cc5bff3b8313632f0fae3fa62c8b85 Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Tue, 23 Jul 2024 20:35:01 -0500 Subject: [PATCH 15/22] ran make and it auto updated manual changes to QuotaService.go --- cloudstack/QuotaService.go | 780 ++++++++++++++++++++++++------------- 1 file changed, 500 insertions(+), 280 deletions(-) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index 7f28459..faf904a 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -27,24 +27,24 @@ import ( type QuotaServiceIface interface { QuotaBalance(p *QuotaBalanceParams) (*QuotaBalanceResponse, error) - NewQuotaBalanceParams(account, domainid string) *QuotaBalanceParams - QuotaCredits(p *QuotaCreditsParams) (*QuotaCreditsParams, error) - NewQuotaCreditsParams(account, domainid, value string) *QuotaCreditsParams + 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, domainid, enddate, startdate string) *QuotaStatementParams + NewQuotaStatementParams(account string, domainid string, enddate string, startdate string) *QuotaStatementParams QuotaSummary(p *QuotaSummaryParams) (*QuotaSummaryResponse, error) NewQuotaSummaryParams() *QuotaSummaryParams QuotaTariffCreate(p *QuotaTariffCreateParams) (*QuotaTariffCreateResponse, error) - NewQuotaTariffCreateParams(name, usagetype, value string) *QuotaTariffCreateParams + 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() (*QuotaUpdateResponse, error) + QuotaUpdate(p *QuotaUpdateParams) (*QuotaUpdateResponse, error) NewQuotaUpdateParams() *QuotaUpdateParams } @@ -60,12 +60,12 @@ func (p *QuotaBalanceParams) toURLValues() url.Values { 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["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)) } @@ -83,10 +83,9 @@ func (p *QuotaBalanceParams) SetAccount(v string) { } func (p *QuotaBalanceParams) ResetAccount() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") } - delete(p.p, "account") } func (p *QuotaBalanceParams) GetAccount() (string, bool) { @@ -97,47 +96,45 @@ func (p *QuotaBalanceParams) GetAccount() (string, bool) { return value, ok } -func (p *QuotaBalanceParams) SetDomainid(v string) { +func (p *QuotaBalanceParams) SetAccountid(v string) { if p.p == nil { p.p = make(map[string]interface{}) } - p.p["domainid"] = v + p.p["accountid"] = v } -func (p *QuotaBalanceParams) ResetDomainid() { - if p.p == nil { - p.p = make(map[string]interface{}) +func (p *QuotaBalanceParams) ResetAccountid() { + if p.p != nil && p.p["accountid"] != nil { + delete(p.p, "accountid") } - delete(p.p, "domainid") } -func (p *QuotaBalanceParams) GetDomainid() (string, bool) { +func (p *QuotaBalanceParams) GetAccountid() (string, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["domainid"].(string) + value, ok := p.p["accountid"].(string) return value, ok } -func (p *QuotaBalanceParams) SetAccountid(v string) { +func (p *QuotaBalanceParams) SetDomainid(v string) { if p.p == nil { p.p = make(map[string]interface{}) } - p.p["accountid"] = v + p.p["domainid"] = v } -func (p *QuotaBalanceParams) ResetAccountid() { - if p.p == nil { - p.p = make(map[string]interface{}) +func (p *QuotaBalanceParams) ResetDomainid() { + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") } - delete(p.p, "accountid") } -func (p *QuotaBalanceParams) GetAccountid() (string, bool) { +func (p *QuotaBalanceParams) GetDomainid() (string, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["accountid"].(string) + value, ok := p.p["domainid"].(string) return value, ok } @@ -149,10 +146,9 @@ func (p *QuotaBalanceParams) SetEnddate(v string) { } func (p *QuotaBalanceParams) ResetEnddate() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["enddate"] != nil { + delete(p.p, "enddate") } - delete(p.p, "enddate") } func (p *QuotaBalanceParams) GetEnddate() (string, bool) { @@ -171,10 +167,9 @@ func (p *QuotaBalanceParams) SetStartdate(v string) { } func (p *QuotaBalanceParams) ResetStartdate() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["startdate"] != nil { + delete(p.p, "startdate") } - delete(p.p, "startdate") } func (p *QuotaBalanceParams) GetStartdate() (string, bool) { @@ -195,6 +190,7 @@ func (s *QuotaService) NewQuotaBalanceParams(account string, domainid string) *Q 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 { @@ -211,11 +207,13 @@ func (s *QuotaService) QuotaBalance(p *QuotaBalanceParams) (*QuotaBalanceRespons type QuotaBalanceResponse struct { Account string `json:"account"` - Accountid string `json:"accountid"` - Domain string `json:"domain"` + Accountid int64 `json:"accountid"` + Domain int64 `json:"domain"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` Name string `json:"name"` Quota string `json:"quota"` - Type string `json:"type"` + Type int `json:"type"` Unit string `json:"unit"` } @@ -234,15 +232,13 @@ func (p *QuotaCreditsParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } - if v, found := p.p["value"]; found { - u.Set("value", v.(string)) - } if v, found := p.p["min_balance"]; found { - u.Set("min_balance", v.(string)) - } if v, found := p.p["quota_enforce"]; found { - u.Set("quota_enforce", v.(string)) + vv := strconv.FormatBool(v.(bool)) + u.Set("quota_enforce", vv) + } + if v, found := p.p["value"]; found { } return u } @@ -255,10 +251,9 @@ func (p *QuotaCreditsParams) SetAccount(v string) { } func (p *QuotaCreditsParams) ResetAccount() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") } - delete(p.p, "account") } func (p *QuotaCreditsParams) GetAccount() (string, bool) { @@ -277,10 +272,9 @@ func (p *QuotaCreditsParams) SetDomainid(v string) { } func (p *QuotaCreditsParams) ResetDomainid() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") } - delete(p.p, "domainid") } func (p *QuotaCreditsParams) GetDomainid() (string, bool) { @@ -291,75 +285,72 @@ func (p *QuotaCreditsParams) GetDomainid() (string, bool) { return value, ok } -func (p *QuotaCreditsParams) SetValue(v string) { +func (p *QuotaCreditsParams) SetMin_balance(v float64) { if p.p == nil { p.p = make(map[string]interface{}) } - p.p["value"] = v + p.p["min_balance"] = v } -func (p *QuotaCreditsParams) ResetValue() { - if p.p == nil { - p.p = make(map[string]interface{}) +func (p *QuotaCreditsParams) ResetMin_balance() { + if p.p != nil && p.p["min_balance"] != nil { + delete(p.p, "min_balance") } - delete(p.p, "value") } -func (p *QuotaCreditsParams) GetValue() (string, bool) { +func (p *QuotaCreditsParams) GetMin_balance() (float64, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["value"].(string) + value, ok := p.p["min_balance"].(float64) return value, ok } -func (p *QuotaCreditsParams) SetMinBalance(v string) { +func (p *QuotaCreditsParams) SetQuota_enforce(v bool) { if p.p == nil { p.p = make(map[string]interface{}) } - p.p["min_balance"] = v + p.p["quota_enforce"] = v } -func (p *QuotaCreditsParams) ResetMinBalance() { - if p.p == nil { - p.p = make(map[string]interface{}) +func (p *QuotaCreditsParams) ResetQuota_enforce() { + if p.p != nil && p.p["quota_enforce"] != nil { + delete(p.p, "quota_enforce") } - delete(p.p, "min_balance") } -func (p *QuotaCreditsParams) GetMinBalance() (string, bool) { +func (p *QuotaCreditsParams) GetQuota_enforce() (bool, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["min_balance"].(string) + value, ok := p.p["quota_enforce"].(bool) return value, ok } -func (p *QuotaCreditsParams) SetQuotaEnforce(v string) { +func (p *QuotaCreditsParams) SetValue(v float64) { if p.p == nil { p.p = make(map[string]interface{}) } - p.p["quota_enforce"] = v + p.p["value"] = v } -func (p *QuotaCreditsParams) ResetQuotaEnforce() { - if p.p == nil { - p.p = make(map[string]interface{}) +func (p *QuotaCreditsParams) ResetValue() { + if p.p != nil && p.p["value"] != nil { + delete(p.p, "value") } - delete(p.p, "quota_enforce") } -func (p *QuotaCreditsParams) GetQuotaEnforce() (string, bool) { +func (p *QuotaCreditsParams) GetValue() (float64, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["quota_enforce"].(string) + 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, domainid, value string) *QuotaCreditsParams { +func (s *QuotaService) NewQuotaCreditsParams(account string, domainid string, value float64) *QuotaCreditsParams { p := &QuotaCreditsParams{} p.p = make(map[string]interface{}) p.p["account"] = account @@ -368,6 +359,7 @@ func (s *QuotaService) NewQuotaCreditsParams(account, domainid, value string) *Q 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 { @@ -385,6 +377,8 @@ func (s *QuotaService) QuotaCredits(p *QuotaCreditsParams) (*QuotaCreditsRespons type QuotaCreditsResponse struct { Credits string `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"` } @@ -442,6 +436,9 @@ func (p *QuotaStatementParams) toURLValues() url.Values { 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)) } @@ -451,11 +448,9 @@ func (p *QuotaStatementParams) toURLValues() url.Values { if v, found := p.p["startdate"]; found { u.Set("startdate", v.(string)) } - if v, found := p.p["accountid"]; found { - u.Set("accountid", v.(string)) - } if v, found := p.p["type"]; found { - u.Set("type", v.(string)) + vv := strconv.Itoa(v.(int)) + u.Set("type", vv) } return u } @@ -468,10 +463,9 @@ func (p *QuotaStatementParams) SetAccount(v string) { } func (p *QuotaStatementParams) ResetAccount() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") } - delete(p.p, "account") } func (p *QuotaStatementParams) GetAccount() (string, bool) { @@ -482,6 +476,27 @@ func (p *QuotaStatementParams) GetAccount() (string, bool) { 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{}) @@ -490,10 +505,9 @@ func (p *QuotaStatementParams) SetDomainid(v string) { } func (p *QuotaStatementParams) ResetDomainid() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") } - delete(p.p, "domainid") } func (p *QuotaStatementParams) GetDomainid() (string, bool) { @@ -512,10 +526,9 @@ func (p *QuotaStatementParams) SetEnddate(v string) { } func (p *QuotaStatementParams) ResetEnddate() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["enddate"] != nil { + delete(p.p, "enddate") } - delete(p.p, "enddate") } func (p *QuotaStatementParams) GetEnddate() (string, bool) { @@ -534,10 +547,9 @@ func (p *QuotaStatementParams) SetStartdate(v string) { } func (p *QuotaStatementParams) ResetStartdate() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["startdate"] != nil { + delete(p.p, "startdate") } - delete(p.p, "startdate") } func (p *QuotaStatementParams) GetStartdate() (string, bool) { @@ -548,29 +560,7 @@ func (p *QuotaStatementParams) GetStartdate() (string, bool) { 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 = make(map[string]interface{}) - } - 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) SetType(v string) { +func (p *QuotaStatementParams) SetType(v int) { if p.p == nil { p.p = make(map[string]interface{}) } @@ -578,23 +568,22 @@ func (p *QuotaStatementParams) SetType(v string) { } func (p *QuotaStatementParams) ResetType() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["type"] != nil { + delete(p.p, "type") } - delete(p.p, "type") } -func (p *QuotaStatementParams) GetType() (string, bool) { +func (p *QuotaStatementParams) GetType() (int, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["type"].(string) + 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, domainid, enddate, startdate string) *QuotaStatementParams { +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 @@ -604,6 +593,7 @@ func (s *QuotaService) NewQuotaStatementParams(account, domainid, enddate, start 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 { @@ -620,11 +610,13 @@ func (s *QuotaService) QuotaStatement(p *QuotaStatementParams) (*QuotaStatementR type QuotaStatementResponse struct { Account string `json:"account"` - Accountid string `json:"accountid"` - Domain string `json:"domain"` + Accountid int64 `json:"accountid"` + Domain int64 `json:"domain"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` Name string `json:"name"` Quota string `json:"quota"` - Type string `json:"type"` + Type int `json:"type"` Unit string `json:"unit"` } @@ -647,7 +639,8 @@ func (p *QuotaSummaryParams) toURLValues() url.Values { u.Set("keyword", v.(string)) } if v, found := p.p["listall"]; found { - u.Add("listall", v.(string)) + vv := strconv.FormatBool(v.(bool)) + u.Set("listall", vv) } if v, found := p.p["page"]; found { vv := strconv.Itoa(v.(int)) @@ -668,10 +661,9 @@ func (p *QuotaSummaryParams) SetAccount(v string) { } func (p *QuotaSummaryParams) ResetAccount() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") } - delete(p.p, "account") } func (p *QuotaSummaryParams) GetAccount() (string, bool) { @@ -690,10 +682,9 @@ func (p *QuotaSummaryParams) SetDomainid(v string) { } func (p *QuotaSummaryParams) ResetDomainid() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") } - delete(p.p, "domainid") } func (p *QuotaSummaryParams) GetDomainid() (string, bool) { @@ -712,10 +703,9 @@ func (p *QuotaSummaryParams) SetKeyword(v string) { } func (p *QuotaSummaryParams) ResetKeyword() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") } - delete(p.p, "keyword") } func (p *QuotaSummaryParams) GetKeyword() (string, bool) { @@ -726,7 +716,7 @@ func (p *QuotaSummaryParams) GetKeyword() (string, bool) { return value, ok } -func (p *QuotaSummaryParams) SetListall(v string) { +func (p *QuotaSummaryParams) SetListall(v bool) { if p.p == nil { p.p = make(map[string]interface{}) } @@ -734,17 +724,16 @@ func (p *QuotaSummaryParams) SetListall(v string) { } func (p *QuotaSummaryParams) ResetListall() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["listall"] != nil { + delete(p.p, "listall") } - delete(p.p, "listall") } -func (p *QuotaSummaryParams) GetListall() (string, bool) { +func (p *QuotaSummaryParams) GetListall() (bool, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["listall"].(string) + value, ok := p.p["listall"].(bool) return value, ok } @@ -756,10 +745,9 @@ func (p *QuotaSummaryParams) SetPage(v int) { } func (p *QuotaSummaryParams) ResetPage() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") } - delete(p.p, "page") } func (p *QuotaSummaryParams) GetPage() (int, bool) { @@ -778,10 +766,9 @@ func (p *QuotaSummaryParams) SetPagesize(v int) { } func (p *QuotaSummaryParams) ResetPagesize() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") } - delete(p.p, "pagesize") } func (p *QuotaSummaryParams) GetPagesize() (int, bool) { @@ -800,6 +787,7 @@ func (s *QuotaService) NewQuotaSummaryParams() *QuotaSummaryParams { 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 { @@ -822,8 +810,10 @@ type QuotaSummaryResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Enddate string `json:"enddate"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` Quota string `json:"quota"` - Quotaenabled string `json:"quotaenabled"` + Quotaenabled bool `json:"quotaenabled"` Startdate string `json:"startdate"` State string `json:"state"` } @@ -837,15 +827,6 @@ func (p *QuotaTariffCreateParams) toURLValues() url.Values { if p.p == nil { return u } - if v, found := p.p["name"]; found { - u.Set("name", v.(string)) - } - if v, found := p.p["usagetype"]; found { - u.Set("usagetype", v.(string)) - } - if v, found := p.p["value"]; found { - u.Set("value", v.(string)) - } if v, found := p.p["activationrule"]; found { u.Set("activationrule", v.(string)) } @@ -855,169 +836,171 @@ func (p *QuotaTariffCreateParams) toURLValues() url.Values { 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["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 { + } return u } -func (p *QuotaTariffCreateParams) SetName(v string) { +func (p *QuotaTariffCreateParams) SetActivationrule(v string) { if p.p == nil { p.p = make(map[string]interface{}) } - p.p["name"] = v + p.p["activationrule"] = v } -func (p *QuotaTariffCreateParams) ResetName() { - if p.p == nil { - p.p = make(map[string]interface{}) +func (p *QuotaTariffCreateParams) ResetActivationrule() { + if p.p != nil && p.p["activationrule"] != nil { + delete(p.p, "activationrule") } - delete(p.p, "name") } -func (p *QuotaTariffCreateParams) GetName() (string, bool) { +func (p *QuotaTariffCreateParams) GetActivationrule() (string, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["name"].(string) + value, ok := p.p["activationrule"].(string) return value, ok } -func (p *QuotaTariffCreateParams) SetUsagetype(v string) { +func (p *QuotaTariffCreateParams) SetDescription(v string) { if p.p == nil { p.p = make(map[string]interface{}) } - p.p["usagetype"] = v + p.p["description"] = v } -func (p *QuotaTariffCreateParams) ResetUsagetype() { - if p.p == nil { - p.p = make(map[string]interface{}) +func (p *QuotaTariffCreateParams) ResetDescription() { + if p.p != nil && p.p["description"] != nil { + delete(p.p, "description") } - delete(p.p, "usagetype") } -func (p *QuotaTariffCreateParams) GetUsagetype() (string, bool) { +func (p *QuotaTariffCreateParams) GetDescription() (string, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["usagetype"].(string) + value, ok := p.p["description"].(string) return value, ok } -func (p *QuotaTariffCreateParams) SetValue(v string) { +func (p *QuotaTariffCreateParams) SetEnddate(v string) { if p.p == nil { p.p = make(map[string]interface{}) } - p.p["value"] = v + p.p["enddate"] = v } -func (p *QuotaTariffCreateParams) ResetValue() { - if p.p == nil { - p.p = make(map[string]interface{}) +func (p *QuotaTariffCreateParams) ResetEnddate() { + if p.p != nil && p.p["enddate"] != nil { + delete(p.p, "enddate") } - delete(p.p, "value") } -func (p *QuotaTariffCreateParams) GetValue() (string, bool) { +func (p *QuotaTariffCreateParams) GetEnddate() (string, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["value"].(string) + value, ok := p.p["enddate"].(string) return value, ok } -func (p *QuotaTariffCreateParams) SetActivationrule(v string) { +func (p *QuotaTariffCreateParams) SetName(v string) { if p.p == nil { p.p = make(map[string]interface{}) } - p.p["activationrule"] = v + p.p["name"] = v } -func (p *QuotaTariffCreateParams) ResetActivationrule() { - if p.p == nil { - p.p = make(map[string]interface{}) +func (p *QuotaTariffCreateParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") } - delete(p.p, "activationrule") } -func (p *QuotaTariffCreateParams) GetActivationrule() (string, bool) { +func (p *QuotaTariffCreateParams) GetName() (string, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["activationrule"].(string) + value, ok := p.p["name"].(string) return value, ok } -func (p *QuotaTariffCreateParams) SetDescription(v string) { +func (p *QuotaTariffCreateParams) SetStartdate(v string) { if p.p == nil { p.p = make(map[string]interface{}) } - p.p["description"] = v + p.p["startdate"] = v } -func (p *QuotaTariffCreateParams) ResetDescription() { - if p.p == nil { - p.p = make(map[string]interface{}) +func (p *QuotaTariffCreateParams) ResetStartdate() { + if p.p != nil && p.p["startdate"] != nil { + delete(p.p, "startdate") } - delete(p.p, "description") } -func (p *QuotaTariffCreateParams) GetDescription() (string, bool) { +func (p *QuotaTariffCreateParams) GetStartdate() (string, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["description"].(string) + value, ok := p.p["startdate"].(string) return value, ok } -func (p *QuotaTariffCreateParams) SetEnddate(v string) { +func (p *QuotaTariffCreateParams) SetUsagetype(v int) { if p.p == nil { p.p = make(map[string]interface{}) } - p.p["enddate"] = v + p.p["usagetype"] = v } -func (p *QuotaTariffCreateParams) ResetEnddate() { - if p.p == nil { - p.p = make(map[string]interface{}) +func (p *QuotaTariffCreateParams) ResetUsagetype() { + if p.p != nil && p.p["usagetype"] != nil { + delete(p.p, "usagetype") } - delete(p.p, "enddate") } -func (p *QuotaTariffCreateParams) GetEnddate() (string, bool) { +func (p *QuotaTariffCreateParams) GetUsagetype() (int, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["enddate"].(string) + value, ok := p.p["usagetype"].(int) return value, ok } -func (p *QuotaTariffCreateParams) SetStartdate(v string) { +func (p *QuotaTariffCreateParams) SetValue(v float64) { if p.p == nil { p.p = make(map[string]interface{}) } - p.p["startdate"] = v + p.p["value"] = v } -func (p *QuotaTariffCreateParams) ResetStartdate() { - if p.p == nil { - p.p = make(map[string]interface{}) +func (p *QuotaTariffCreateParams) ResetValue() { + if p.p != nil && p.p["value"] != nil { + delete(p.p, "value") } - delete(p.p, "startdate") } -func (p *QuotaTariffCreateParams) GetStartdate() (string, bool) { +func (p *QuotaTariffCreateParams) GetValue() (float64, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["startdate"].(string) + 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, usagetype, value string) *QuotaTariffCreateParams { +func (s *QuotaService) NewQuotaTariffCreateParams(name string, usagetype int, value float64) *QuotaTariffCreateParams { p := &QuotaTariffCreateParams{} p.p = make(map[string]interface{}) p.p["name"] = name @@ -1026,6 +1009,7 @@ func (s *QuotaService) NewQuotaTariffCreateParams(name, usagetype, value string) return p } +// Creates a quota tariff for a resource. func (s *QuotaService) QuotaTariffCreate(p *QuotaTariffCreateParams) (*QuotaTariffCreateResponse, error) { resp, err := s.cs.newRequest("quotaTariffCreate", p.toURLValues()) if err != nil { @@ -1041,17 +1025,19 @@ func (s *QuotaService) QuotaTariffCreate(p *QuotaTariffCreateParams) (*QuotaTari } type QuotaTariffCreateResponse struct { - Activationrule string `json:"activationRule"` + ActivationRule string `json:"activationRule"` Currency string `json:"currency"` Description string `json:"description"` EffectiveDate string `json:"effectiveDate"` EndDate string `json:"endDate"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` Name string `json:"name"` Removed string `json:"removed"` TariffValue string `json:"tariffValue"` UsageDiscriminator string `json:"usageDiscriminator"` UsageName string `json:"usageName"` - UsageType string `json:"usageType"` + UsageType int `json:"usageType"` UsageTypeDescription string `json:"usageTypeDescription"` UsageUnit string `json:"usageUnit"` Uuid string `json:"uuid"` @@ -1080,10 +1066,9 @@ func (p *QuotaTariffDeleteParams) SetId(v string) { } func (p *QuotaTariffDeleteParams) ResetId() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") } - delete(p.p, "id") } func (p *QuotaTariffDeleteParams) GetId() (string, bool) { @@ -1103,6 +1088,7 @@ func (s *QuotaService) NewQuotaTariffDeleteParams(id string) *QuotaTariffDeleteP 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 { @@ -1118,10 +1104,39 @@ func (s *QuotaService) QuotaTariffDelete(p *QuotaTariffDeleteParams) (*QuotaTari } type QuotaTariffDeleteResponse struct { - DisplayText string `json:"displaytext"` + 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{} } @@ -1131,9 +1146,205 @@ func (p *QuotaTariffListParams) toURLValues() 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["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["listall"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("listall", vv) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["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) 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) 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 { @@ -1142,6 +1353,7 @@ func (s *QuotaService) NewQuotaTariffListParams() *QuotaTariffListParams { 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 { @@ -1157,17 +1369,19 @@ func (s *QuotaService) QuotaTariffList(p *QuotaTariffListParams) (*QuotaTariffLi } type QuotaTariffListResponse struct { - Activationrule string `json:"activationRule"` + ActivationRule string `json:"activationRule"` Currency string `json:"currency"` Description string `json:"description"` EffectiveDate string `json:"effectiveDate"` EndDate string `json:"endDate"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` Name string `json:"name"` Removed string `json:"removed"` TariffValue string `json:"tariffValue"` UsageDiscriminator string `json:"usageDiscriminator"` UsageName string `json:"usageName"` - UsageType string `json:"usageType"` + UsageType int `json:"usageType"` UsageTypeDescription string `json:"usageTypeDescription"` UsageUnit string `json:"usageUnit"` Uuid string `json:"uuid"` @@ -1182,50 +1396,28 @@ func (p *QuotaTariffUpdateParams) toURLValues() url.Values { if p.p == nil { return u } - if v, found := p.p["name"]; found { - u.Set("name", v.(string)) - } if v, found := p.p["activationrule"]; found { u.Set("activationrule", v.(string)) } - if v, found := p.p["usagetype"]; found { - u.Set("usagetype", v.(string)) - } - if v, found := p.p["value"]; found { - u.Set("value", 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["startdate"]; found { u.Set("startdate", v.(string)) } - return u -} - -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 = make(map[string]interface{}) + if v, found := p.p["usagetype"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("usagetype", vv) } - delete(p.p, "name") -} - -func (p *QuotaTariffUpdateParams) GetName() (string, bool) { - if p.p == nil { - p.p = make(map[string]interface{}) + if v, found := p.p["value"]; found { } - value, ok := p.p["name"].(string) - return value, ok + return u } func (p *QuotaTariffUpdateParams) SetActivationrule(v string) { @@ -1236,10 +1428,9 @@ func (p *QuotaTariffUpdateParams) SetActivationrule(v string) { } func (p *QuotaTariffUpdateParams) ResetActivationrule() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["activationrule"] != nil { + delete(p.p, "activationrule") } - delete(p.p, "activationrule") } func (p *QuotaTariffUpdateParams) GetActivationrule() (string, bool) { @@ -1258,10 +1449,9 @@ func (p *QuotaTariffUpdateParams) SetDescription(v string) { } func (p *QuotaTariffUpdateParams) ResetDescription() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["description"] != nil { + delete(p.p, "description") } - delete(p.p, "description") } func (p *QuotaTariffUpdateParams) GetDescription() (string, bool) { @@ -1272,7 +1462,20 @@ func (p *QuotaTariffUpdateParams) GetDescription() (string, bool) { return value, ok } -func (p *QuotaTariffUpdateParams) SetEnddate() (string, bool) { +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{}) } @@ -1280,18 +1483,24 @@ func (p *QuotaTariffUpdateParams) SetEnddate() (string, bool) { return value, ok } -func (p *QuotaTariffUpdateParams) ResetEnddate() { +func (p *QuotaTariffUpdateParams) SetName(v string) { if p.p == nil { p.p = make(map[string]interface{}) } - delete(p.p, "enddate") + p.p["name"] = v } -func (p *QuotaTariffUpdateParams) GetEnddate() (string, bool) { +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["enddate"].(string) + value, ok := p.p["name"].(string) return value, ok } @@ -1303,10 +1512,9 @@ func (p *QuotaTariffUpdateParams) SetStartdate(v string) { } func (p *QuotaTariffUpdateParams) ResetStartdate() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["startdate"] != nil { + delete(p.p, "startdate") } - delete(p.p, "startdate") } func (p *QuotaTariffUpdateParams) GetStartdate() (string, bool) { @@ -1317,7 +1525,7 @@ func (p *QuotaTariffUpdateParams) GetStartdate() (string, bool) { return value, ok } -func (p *QuotaTariffUpdateParams) SetUsagetype(v string) { +func (p *QuotaTariffUpdateParams) SetUsagetype(v int) { if p.p == nil { p.p = make(map[string]interface{}) } @@ -1325,21 +1533,20 @@ func (p *QuotaTariffUpdateParams) SetUsagetype(v string) { } func (p *QuotaTariffUpdateParams) ResetUsagetype() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["usagetype"] != nil { + delete(p.p, "usagetype") } - delete(p.p, "usagetype") } -func (p *QuotaTariffUpdateParams) GetUsagetype() (string, bool) { +func (p *QuotaTariffUpdateParams) GetUsagetype() (int, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["usagetype"].(string) + value, ok := p.p["usagetype"].(int) return value, ok } -func (p *QuotaTariffUpdateParams) SetValue(v string) { +func (p *QuotaTariffUpdateParams) SetValue(v float64) { if p.p == nil { p.p = make(map[string]interface{}) } @@ -1347,17 +1554,16 @@ func (p *QuotaTariffUpdateParams) SetValue(v string) { } func (p *QuotaTariffUpdateParams) ResetValue() { - if p.p == nil { - p.p = make(map[string]interface{}) + if p.p != nil && p.p["value"] != nil { + delete(p.p, "value") } - delete(p.p, "value") } -func (p *QuotaTariffUpdateParams) GetValue() (string, bool) { +func (p *QuotaTariffUpdateParams) GetValue() (float64, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["value"].(string) + value, ok := p.p["value"].(float64) return value, ok } @@ -1370,6 +1576,7 @@ func (s *QuotaService) NewQuotaTariffUpdateParams(name string) *QuotaTariffUpdat 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 { @@ -1385,17 +1592,19 @@ func (s *QuotaService) QuotaTariffUpdate(p *QuotaTariffUpdateParams) (*QuotaTari } type QuotaTariffUpdateResponse struct { - Activationrule string `json:"activationRule"` + ActivationRule string `json:"activationRule"` Currency string `json:"currency"` Description string `json:"description"` EffectiveDate string `json:"effectiveDate"` EndDate string `json:"endDate"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` Name string `json:"name"` Removed string `json:"removed"` TariffValue string `json:"tariffValue"` UsageDiscriminator string `json:"usageDiscriminator"` UsageName string `json:"usageName"` - UsageType string `json:"usageType"` + UsageType int `json:"usageType"` UsageTypeDescription string `json:"usageTypeDescription"` UsageUnit string `json:"usageUnit"` Uuid string `json:"uuid"` @@ -1405,6 +1614,14 @@ 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 { @@ -1413,8 +1630,9 @@ func (s *QuotaService) NewQuotaUpdateParams() *QuotaUpdateParams { return p } -func (s *QuotaService) QuotaUpdate() (*QuotaUpdateResponse, error) { - resp, err := s.cs.newRequest("quotaUpdate", nil) +// 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 } @@ -1428,5 +1646,7 @@ func (s *QuotaService) QuotaUpdate() (*QuotaUpdateResponse, error) { } type QuotaUpdateResponse struct { - UpdatedOn string `json:"updated_on"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Updated_on string `json:"updated_on"` } From da715ada46fa568662d5d47ec808d9ce9ac07c49 Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Tue, 23 Jul 2024 21:28:45 -0500 Subject: [PATCH 16/22] fix url value generation for double/float64 types --- generate/generate.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/generate/generate.go b/generate/generate.go index 3bc2b61..cf8bbcd 100644 --- a/generate/generate.go +++ b/generate/generate.go @@ -1313,6 +1313,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) From f4341f1591891b3e72bfcb9394d366e2a2c8a3a9 Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Thu, 25 Jul 2024 19:37:57 -0500 Subject: [PATCH 17/22] update generated files --- cloudstack/QuotaService.go | 8 + cloudstack/QuotaService_mock.go | 261 ++++++++++++++++++++++++++++++++ test/QuotaService_test.go | 108 +++++++++++++ 3 files changed, 377 insertions(+) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index faf904a..9abf7d6 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -233,12 +233,16 @@ func (p *QuotaCreditsParams) toURLValues() url.Values { 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 } @@ -847,6 +851,8 @@ func (p *QuotaTariffCreateParams) toURLValues() url.Values { 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 } @@ -1416,6 +1422,8 @@ func (p *QuotaTariffUpdateParams) toURLValues() url.Values { 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 } diff --git a/cloudstack/QuotaService_mock.go b/cloudstack/QuotaService_mock.go index 456eeac..c3732d6 100644 --- a/cloudstack/QuotaService_mock.go +++ b/cloudstack/QuotaService_mock.go @@ -52,6 +52,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 interface{}) *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 interface{}) *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() @@ -66,6 +94,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 interface{}) *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 interface{}) *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 interface{}) *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 interface{}) *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 interface{}) *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 interface{}) *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() @@ -80,3 +236,108 @@ func (mr *MockQuotaServiceIfaceMockRecorder) QuotaIsEnabled(p interface{}) *gomo 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 interface{}) *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 interface{}) *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 interface{}) *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 interface{}) *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 interface{}) *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 interface{}) *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 interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "QuotaUpdate", reflect.TypeOf((*MockQuotaServiceIface)(nil).QuotaUpdate), p) +} diff --git a/test/QuotaService_test.go b/test/QuotaService_test.go index 8d1c04f..42299ab 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,88 @@ 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) + _, err := client.Quota.QuotaTariffCreate(p) + if err != nil { + t.Errorf(err.Error()) + } + } + 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") + _, err := client.Quota.QuotaTariffUpdate(p) + if err != nil { + t.Errorf(err.Error()) + } + } + 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) + } From a5275674c9560083cb1c4e9b655075afd401ee0a Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Sat, 27 Jul 2024 10:17:59 -0500 Subject: [PATCH 18/22] fix types for QuotaService --- cloudstack/QuotaService.go | 175 +++++++++++++++++++------------------ generate/generate.go | 7 +- 2 files changed, 95 insertions(+), 87 deletions(-) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index 9abf7d6..d790c41 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -206,15 +206,15 @@ func (s *QuotaService) QuotaBalance(p *QuotaBalanceParams) (*QuotaBalanceRespons } type QuotaBalanceResponse struct { - Account string `json:"account"` - Accountid int64 `json:"accountid"` - Domain int64 `json:"domain"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Quota string `json:"quota"` - Type int `json:"type"` - Unit string `json:"unit"` + Account string `json:"account"` + Accountid int64 `json:"accountid"` + Domain int64 `json:"domain"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Quota float64 `json:"quota"` + Type int `json:"type"` + Unit string `json:"unit"` } type QuotaCreditsParams struct { @@ -379,12 +379,12 @@ func (s *QuotaService) QuotaCredits(p *QuotaCreditsParams) (*QuotaCreditsRespons } type QuotaCreditsResponse struct { - Credits string `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"` + 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 { @@ -613,15 +613,15 @@ func (s *QuotaService) QuotaStatement(p *QuotaStatementParams) (*QuotaStatementR } type QuotaStatementResponse struct { - Account string `json:"account"` - Accountid int64 `json:"accountid"` - Domain int64 `json:"domain"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Quota string `json:"quota"` - Type int `json:"type"` - Unit string `json:"unit"` + Account string `json:"account"` + Accountid int64 `json:"accountid"` + Domain int64 `json:"domain"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Quota float64 `json:"quota"` + Type int `json:"type"` + Unit string `json:"unit"` } type QuotaSummaryParams struct { @@ -807,19 +807,24 @@ func (s *QuotaService) QuotaSummary(p *QuotaSummaryParams) (*QuotaSummaryRespons } type QuotaSummaryResponse struct { - Account string `json:"account"` - Accountid string `json:"accountid"` - Balance string `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 string `json:"quota"` - Quotaenabled bool `json:"quotaenabled"` - Startdate string `json:"startdate"` - State string `json:"state"` + 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 { @@ -1031,22 +1036,22 @@ func (s *QuotaService) QuotaTariffCreate(p *QuotaTariffCreateParams) (*QuotaTari } type QuotaTariffCreateResponse struct { - ActivationRule string `json:"activationRule"` - Currency string `json:"currency"` - Description string `json:"description"` - EffectiveDate string `json:"effectiveDate"` - EndDate string `json:"endDate"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Removed string `json:"removed"` - TariffValue string `json:"tariffValue"` - UsageDiscriminator string `json:"usageDiscriminator"` - UsageName string `json:"usageName"` - UsageType int `json:"usageType"` - UsageTypeDescription string `json:"usageTypeDescription"` - UsageUnit string `json:"usageUnit"` - Uuid string `json:"uuid"` + ActivationRule string `json:"activationRule"` + Currency string `json:"currency"` + Description string `json:"description"` + EffectiveDate string `json:"effectiveDate"` + EndDate string `json:"endDate"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + 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"` + Uuid string `json:"uuid"` } type QuotaTariffDeleteParams struct { @@ -1375,22 +1380,22 @@ func (s *QuotaService) QuotaTariffList(p *QuotaTariffListParams) (*QuotaTariffLi } type QuotaTariffListResponse struct { - ActivationRule string `json:"activationRule"` - Currency string `json:"currency"` - Description string `json:"description"` - EffectiveDate string `json:"effectiveDate"` - EndDate string `json:"endDate"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Removed string `json:"removed"` - TariffValue string `json:"tariffValue"` - UsageDiscriminator string `json:"usageDiscriminator"` - UsageName string `json:"usageName"` - UsageType int `json:"usageType"` - UsageTypeDescription string `json:"usageTypeDescription"` - UsageUnit string `json:"usageUnit"` - Uuid string `json:"uuid"` + ActivationRule string `json:"activationRule"` + Currency string `json:"currency"` + Description string `json:"description"` + EffectiveDate string `json:"effectiveDate"` + EndDate string `json:"endDate"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + 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"` + Uuid string `json:"uuid"` } type QuotaTariffUpdateParams struct { @@ -1600,22 +1605,22 @@ func (s *QuotaService) QuotaTariffUpdate(p *QuotaTariffUpdateParams) (*QuotaTari } type QuotaTariffUpdateResponse struct { - ActivationRule string `json:"activationRule"` - Currency string `json:"currency"` - Description string `json:"description"` - EffectiveDate string `json:"effectiveDate"` - EndDate string `json:"endDate"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Removed string `json:"removed"` - TariffValue string `json:"tariffValue"` - UsageDiscriminator string `json:"usageDiscriminator"` - UsageName string `json:"usageName"` - UsageType int `json:"usageType"` - UsageTypeDescription string `json:"usageTypeDescription"` - UsageUnit string `json:"usageUnit"` - Uuid string `json:"uuid"` + ActivationRule string `json:"activationRule"` + Currency string `json:"currency"` + Description string `json:"description"` + EffectiveDate string `json:"effectiveDate"` + EndDate string `json:"endDate"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + 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"` + Uuid string `json:"uuid"` } type QuotaUpdateParams struct { diff --git a/generate/generate.go b/generate/generate.go index cf8bbcd..24aa2a7 100644 --- a/generate/generate.go +++ b/generate/generate.go @@ -1868,7 +1868,7 @@ func (s *service) generateResponseType(a *API) { // 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" { + if strings.HasPrefix(a.Name, "list") || a.Name == "registerTemplate" || a.Name == "findHostsForMigration" || a.Name == "quotaSummary" { pn("type %s struct {", tn) // This nasty check is for some specific response that do not behave consistent @@ -1902,6 +1902,9 @@ func (s *service) generateResponseType(a *API) { case "findHostsForMigration": pn(" Count int `json:\"count\"`") pn(" Host []*%s `json:\"%s\"`", customResponseStructTypes[a.Name], "host") + 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))) @@ -2165,7 +2168,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" { From aacb1d9f42b25d493e6e7199b17cc95c7911a084 Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Sat, 27 Jul 2024 11:28:17 -0500 Subject: [PATCH 19/22] fix quotaTariffList --- cloudstack/QuotaService.go | 5 +++++ generate/generate.go | 6 +++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index d790c41..53ca6f5 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -1380,6 +1380,11 @@ func (s *QuotaService) QuotaTariffList(p *QuotaTariffListParams) (*QuotaTariffLi } 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"` diff --git a/generate/generate.go b/generate/generate.go index 24aa2a7..004c534 100644 --- a/generate/generate.go +++ b/generate/generate.go @@ -1868,7 +1868,8 @@ func (s *service) generateResponseType(a *API) { // 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 == "quotaSummary" { + if strings.HasPrefix(a.Name, "list") || a.Name == "registerTemplate" || a.Name == "findHostsForMigration" || + a.Name == "quotaSummary" || a.Name == "quotaTariffList" { pn("type %s struct {", tn) // This nasty check is for some specific response that do not behave consistent @@ -1902,6 +1903,9 @@ func (s *service) generateResponseType(a *API) { case "findHostsForMigration": pn(" Count int `json:\"count\"`") pn(" Host []*%s `json:\"%s\"`", customResponseStructTypes[a.Name], "host") + case "quotaTariffList": + pn(" Count int `json:\"count\"`") + pn(" %s []*%s `json:\"%s\"`", ln, parseSingular(ln), "quotatariff") case "quotaSummary": pn(" Count int `json:\"count\"`") pn(" %s []*%s `json:\"%s\"`", ln, parseSingular(ln), "summary") From f4dae2a72a1092e8f3ce295c8ccb3c777db35d1b Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Sat, 27 Jul 2024 12:33:51 -0500 Subject: [PATCH 20/22] add custom quotaStatement response type to match actual cloudstack api response --- cloudstack/QuotaService.go | 23 ++++++++++++++++------- generate/generate.go | 37 +++++++++++++++++++++++++++++++++---- 2 files changed, 49 insertions(+), 11 deletions(-) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index 53ca6f5..66aae9d 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -613,15 +613,24 @@ func (s *QuotaService) QuotaStatement(p *QuotaStatementParams) (*QuotaStatementR } type QuotaStatementResponse struct { - Account string `json:"account"` - Accountid int64 `json:"accountid"` - Domain int64 `json:"domain"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Quota float64 `json:"quota"` + 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 { diff --git a/generate/generate.go b/generate/generate.go index 004c534..1387c9f 100644 --- a/generate/generate.go +++ b/generate/generate.go @@ -1863,13 +1863,40 @@ 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 == "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 == "quotaSummary" || a.Name == "quotaTariffList" { + 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 @@ -1903,12 +1930,14 @@ func (s *service) generateResponseType(a *API) { case "findHostsForMigration": pn(" Count int `json:\"count\"`") pn(" Host []*%s `json:\"%s\"`", customResponseStructTypes[a.Name], "host") - 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") + case "quotaTariffList": + pn(" Count int `json:\"count\"`") + pn(" %s []*%s `json:\"%s\"`", ln, parseSingular(ln), "quotatariff") default: pn(" Count int `json:\"count\"`") pn(" %s []*%s `json:\"%s\"`", ln, parseSingular(ln), strings.ToLower(parseSingular(ln))) From 0e9c0d0c3f2ae4e14becd741ae602bc0749d71f2 Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Sat, 27 Jul 2024 12:49:26 -0500 Subject: [PATCH 21/22] add custom response type for QuotaBalance --- cloudstack/QuotaService.go | 17 ++++++++--------- generate/generate.go | 14 ++++++++++++++ 2 files changed, 22 insertions(+), 9 deletions(-) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index 66aae9d..0c4eb44 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -206,15 +206,14 @@ func (s *QuotaService) QuotaBalance(p *QuotaBalanceParams) (*QuotaBalanceRespons } type QuotaBalanceResponse struct { - Account string `json:"account"` - Accountid int64 `json:"accountid"` - Domain int64 `json:"domain"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Quota float64 `json:"quota"` - Type int `json:"type"` - Unit string `json:"unit"` + 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 { diff --git a/generate/generate.go b/generate/generate.go index 1387c9f..1ad51e4 100644 --- a/generate/generate.go +++ b/generate/generate.go @@ -1865,6 +1865,20 @@ func (s *service) generateResponseType(a *API) { 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\"`") From 20651007e45ebbb8ec2c9ec54531f584e497dfeb Mon Sep 17 00:00:00 2001 From: tonymmm1 Date: Sat, 27 Jul 2024 13:13:19 -0500 Subject: [PATCH 22/22] ensure that quotaTariffCreate uses POST --- cloudstack/QuotaService.go | 2 +- generate/generate.go | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index 0c4eb44..e3490c5 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -1030,7 +1030,7 @@ func (s *QuotaService) NewQuotaTariffCreateParams(name string, usagetype int, va // Creates a quota tariff for a resource. func (s *QuotaService) QuotaTariffCreate(p *QuotaTariffCreateParams) (*QuotaTariffCreateResponse, error) { - resp, err := s.cs.newRequest("quotaTariffCreate", p.toURLValues()) + resp, err := s.cs.newPostRequest("quotaTariffCreate", p.toURLValues()) if err != nil { return nil, err } diff --git a/generate/generate.go b/generate/generate.go index 1ad51e4..de8554c 100644 --- a/generate/generate.go +++ b/generate/generate.go @@ -70,6 +70,7 @@ var requiresPostMethod = map[string]bool{ "registerUserData": true, "setupUserTwoFactorAuthentication": true, "validateUserTwoFactorAuthenticationCode": true, + "quotaTariffCreate": true, } var mapRequireList = map[string]map[string]bool{