diff --git a/cloudstack/AccountService.go b/cloudstack/AccountService.go index 0e9d4a66..cb9f28a5 100644 --- a/cloudstack/AccountService.go +++ b/cloudstack/AccountService.go @@ -430,6 +430,8 @@ type CreateAccountResponseUser struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` Lastname string `json:"lastname"` @@ -724,6 +726,8 @@ type DisableAccountResponseUser struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` Lastname string `json:"lastname"` @@ -902,6 +906,8 @@ type EnableAccountResponseUser struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` Lastname string `json:"lastname"` @@ -1435,6 +1441,8 @@ type AccountUser struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` Lastname string `json:"lastname"` @@ -1885,6 +1893,8 @@ type LockAccountResponseUser struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` Lastname string `json:"lastname"` @@ -2086,6 +2096,8 @@ type MarkDefaultZoneForAccountResponseUser struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` Lastname string `json:"lastname"` @@ -2339,6 +2351,8 @@ type UpdateAccountResponseUser struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` Lastname string `json:"lastname"` diff --git a/cloudstack/AffinityGroupService.go b/cloudstack/AffinityGroupService.go index 6f15ea5b..10264f04 100644 --- a/cloudstack/AffinityGroupService.go +++ b/cloudstack/AffinityGroupService.go @@ -953,6 +953,8 @@ func (s *AffinityGroupService) UpdateVMAffinityGroup(p *UpdateVMAffinityGroupPar type UpdateVMAffinityGroupResponse struct { Account string `json:"account"` Affinitygroup []UpdateVMAffinityGroupResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -978,6 +980,7 @@ type UpdateVMAffinityGroupResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -1023,6 +1026,11 @@ type UpdateVMAffinityGroupResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` diff --git a/cloudstack/AuthenticationService.go b/cloudstack/AuthenticationService.go index 653f3cbd..b14482ca 100644 --- a/cloudstack/AuthenticationService.go +++ b/cloudstack/AuthenticationService.go @@ -146,9 +146,13 @@ type LoginResponse struct { Account string `json:"account"` Domainid string `json:"domainid"` Firstname string `json:"firstname"` + Is2faenabled string `json:"is2faenabled"` + Is2faverified string `json:"is2faverified"` + Issuerfor2fa string `json:"issuerfor2fa"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Lastname string `json:"lastname"` + Providerfor2fa string `json:"providerfor2fa"` Registered string `json:"registered"` Sessionkey string `json:"sessionkey"` Timeout int `json:"timeout"` diff --git a/cloudstack/AutoScaleService.go b/cloudstack/AutoScaleService.go index c5b063dd..b14e12ff 100644 --- a/cloudstack/AutoScaleService.go +++ b/cloudstack/AutoScaleService.go @@ -37,7 +37,7 @@ type AutoScaleServiceIface interface { CreateCondition(p *CreateConditionParams) (*CreateConditionResponse, error) NewCreateConditionParams(counterid string, relationaloperator string, threshold int64) *CreateConditionParams CreateCounter(p *CreateCounterParams) (*CreateCounterResponse, error) - NewCreateCounterParams(name string, source string, value string) *CreateCounterParams + NewCreateCounterParams(name string, provider string, source string, value string) *CreateCounterParams DeleteAutoScalePolicy(p *DeleteAutoScalePolicyParams) (*DeleteAutoScalePolicyResponse, error) NewDeleteAutoScalePolicyParams(id string) *DeleteAutoScalePolicyParams DeleteAutoScaleVmGroup(p *DeleteAutoScaleVmGroupParams) (*DeleteAutoScaleVmGroupResponse, error) @@ -54,9 +54,13 @@ type AutoScaleServiceIface interface { NewEnableAutoScaleVmGroupParams(id string) *EnableAutoScaleVmGroupParams ListAutoScalePolicies(p *ListAutoScalePoliciesParams) (*ListAutoScalePoliciesResponse, error) NewListAutoScalePoliciesParams() *ListAutoScalePoliciesParams + GetAutoScalePolicyID(name string, opts ...OptionFunc) (string, int, error) + GetAutoScalePolicyByName(name string, opts ...OptionFunc) (*AutoScalePolicy, int, error) GetAutoScalePolicyByID(id string, opts ...OptionFunc) (*AutoScalePolicy, int, error) ListAutoScaleVmGroups(p *ListAutoScaleVmGroupsParams) (*ListAutoScaleVmGroupsResponse, error) NewListAutoScaleVmGroupsParams() *ListAutoScaleVmGroupsParams + GetAutoScaleVmGroupID(name string, opts ...OptionFunc) (string, int, error) + GetAutoScaleVmGroupByName(name string, opts ...OptionFunc) (*AutoScaleVmGroup, int, error) GetAutoScaleVmGroupByID(id string, opts ...OptionFunc) (*AutoScaleVmGroup, int, error) ListAutoScaleVmProfiles(p *ListAutoScaleVmProfilesParams) (*ListAutoScaleVmProfilesResponse, error) NewListAutoScaleVmProfilesParams() *ListAutoScaleVmProfilesParams @@ -97,6 +101,9 @@ func (p *CreateAutoScalePolicyParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("duration", vv) } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } if v, found := p.p["quiettime"]; found { vv := strconv.Itoa(v.(int)) u.Set("quiettime", vv) @@ -149,6 +156,21 @@ func (p *CreateAutoScalePolicyParams) GetDuration() (int, bool) { return value, ok } +func (p *CreateAutoScalePolicyParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *CreateAutoScalePolicyParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + func (p *CreateAutoScalePolicyParams) SetQuiettime(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -220,6 +242,7 @@ type CreateAutoScalePolicyResponse struct { Id string `json:"id"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Name string `json:"name"` Project string `json:"project"` Projectid string `json:"projectid"` Quiettime int `json:"quiettime"` @@ -253,6 +276,9 @@ func (p *CreateAutoScaleVmGroupParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("minmembers", vv) } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } if v, found := p.p["scaledownpolicyids"]; found { vv := strings.Join(v.([]string), ",") u.Set("scaledownpolicyids", vv) @@ -342,6 +368,21 @@ func (p *CreateAutoScaleVmGroupParams) GetMinmembers() (int, bool) { return value, ok } +func (p *CreateAutoScaleVmGroupParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *CreateAutoScaleVmGroupParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + func (p *CreateAutoScaleVmGroupParams) SetScaledownpolicyids(v []string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -437,23 +478,34 @@ func (s *AutoScaleService) CreateAutoScaleVmGroup(p *CreateAutoScaleVmGroupParam } type CreateAutoScaleVmGroupResponse struct { - Account string `json:"account"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Fordisplay bool `json:"fordisplay"` - Id string `json:"id"` - Interval int `json:"interval"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Lbruleid string `json:"lbruleid"` - Maxmembers int `json:"maxmembers"` - Minmembers int `json:"minmembers"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Scaledownpolicies []string `json:"scaledownpolicies"` - Scaleuppolicies []string `json:"scaleuppolicies"` - State string `json:"state"` - Vmprofileid string `json:"vmprofileid"` + Account string `json:"account"` + Associatednetworkid string `json:"associatednetworkid"` + Associatednetworkname string `json:"associatednetworkname"` + Availablevirtualmachinecount int `json:"availablevirtualmachinecount"` + Created string `json:"created"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Fordisplay bool `json:"fordisplay"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Interval int `json:"interval"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Lbprovider string `json:"lbprovider"` + Lbruleid string `json:"lbruleid"` + Maxmembers int `json:"maxmembers"` + Minmembers int `json:"minmembers"` + Name string `json:"name"` + Privateport string `json:"privateport"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Publicip string `json:"publicip"` + Publicipid string `json:"publicipid"` + Publicport string `json:"publicport"` + Scaledownpolicies []string `json:"scaledownpolicies"` + Scaleuppolicies []string `json:"scaleuppolicies"` + State string `json:"state"` + Vmprofileid string `json:"vmprofileid"` } type CreateAutoScaleVmProfileParams struct { @@ -465,6 +517,9 @@ func (p *CreateAutoScaleVmProfileParams) toURLValues() 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["autoscaleuserid"]; found { u.Set("autoscaleuserid", v.(string)) } @@ -475,16 +530,26 @@ func (p *CreateAutoScaleVmProfileParams) toURLValues() url.Values { u.Set(fmt.Sprintf("counterparam[%d].value", i), m[k]) } } - if v, found := p.p["destroyvmgraceperiod"]; found { + if v, found := p.p["domainid"]; found { + u.Set("domainid", v.(string)) + } + if v, found := p.p["expungevmgraceperiod"]; found { vv := strconv.Itoa(v.(int)) - u.Set("destroyvmgraceperiod", vv) + u.Set("expungevmgraceperiod", vv) } if v, found := p.p["fordisplay"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("fordisplay", vv) } if v, found := p.p["otherdeployparams"]; found { - u.Set("otherdeployparams", v.(string)) + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("otherdeployparams[%d].key", i), k) + u.Set(fmt.Sprintf("otherdeployparams[%d].value", i), m[k]) + } + } + if v, found := p.p["projectid"]; found { + u.Set("projectid", v.(string)) } if v, found := p.p["serviceofferingid"]; found { u.Set("serviceofferingid", v.(string)) @@ -492,12 +557,30 @@ func (p *CreateAutoScaleVmProfileParams) toURLValues() url.Values { if v, found := p.p["templateid"]; found { u.Set("templateid", v.(string)) } + if v, found := p.p["userdata"]; found { + u.Set("userdata", v.(string)) + } if v, found := p.p["zoneid"]; found { u.Set("zoneid", v.(string)) } return u } +func (p *CreateAutoScaleVmProfileParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *CreateAutoScaleVmProfileParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + func (p *CreateAutoScaleVmProfileParams) SetAutoscaleuserid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -528,18 +611,33 @@ func (p *CreateAutoScaleVmProfileParams) GetCounterparam() (map[string]string, b return value, ok } -func (p *CreateAutoScaleVmProfileParams) SetDestroyvmgraceperiod(v int) { +func (p *CreateAutoScaleVmProfileParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *CreateAutoScaleVmProfileParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + +func (p *CreateAutoScaleVmProfileParams) SetExpungevmgraceperiod(v int) { if p.p == nil { p.p = make(map[string]interface{}) } - p.p["destroyvmgraceperiod"] = v + p.p["expungevmgraceperiod"] = v } -func (p *CreateAutoScaleVmProfileParams) GetDestroyvmgraceperiod() (int, bool) { +func (p *CreateAutoScaleVmProfileParams) GetExpungevmgraceperiod() (int, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["destroyvmgraceperiod"].(int) + value, ok := p.p["expungevmgraceperiod"].(int) return value, ok } @@ -558,18 +656,33 @@ func (p *CreateAutoScaleVmProfileParams) GetFordisplay() (bool, bool) { return value, ok } -func (p *CreateAutoScaleVmProfileParams) SetOtherdeployparams(v string) { +func (p *CreateAutoScaleVmProfileParams) SetOtherdeployparams(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) } p.p["otherdeployparams"] = v } -func (p *CreateAutoScaleVmProfileParams) GetOtherdeployparams() (string, bool) { +func (p *CreateAutoScaleVmProfileParams) GetOtherdeployparams() (map[string]string, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["otherdeployparams"].(string) + value, ok := p.p["otherdeployparams"].(map[string]string) + return value, ok +} + +func (p *CreateAutoScaleVmProfileParams) SetProjectid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectid"] = v +} + +func (p *CreateAutoScaleVmProfileParams) GetProjectid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectid"].(string) return value, ok } @@ -603,6 +716,21 @@ func (p *CreateAutoScaleVmProfileParams) GetTemplateid() (string, bool) { return value, ok } +func (p *CreateAutoScaleVmProfileParams) SetUserdata(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdata"] = v +} + +func (p *CreateAutoScaleVmProfileParams) GetUserdata() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdata"].(string) + return value, ok +} + func (p *CreateAutoScaleVmProfileParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -665,21 +793,22 @@ func (s *AutoScaleService) CreateAutoScaleVmProfile(p *CreateAutoScaleVmProfileP } type CreateAutoScaleVmProfileResponse struct { - Account string `json:"account"` - Autoscaleuserid string `json:"autoscaleuserid"` - Destroyvmgraceperiod int `json:"destroyvmgraceperiod"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Fordisplay bool `json:"fordisplay"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Otherdeployparams string `json:"otherdeployparams"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Serviceofferingid string `json:"serviceofferingid"` - Templateid string `json:"templateid"` - Zoneid string `json:"zoneid"` + Account string `json:"account"` + Autoscaleuserid string `json:"autoscaleuserid"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Expungevmgraceperiod int `json:"expungevmgraceperiod"` + Fordisplay bool `json:"fordisplay"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Otherdeployparams map[string]string `json:"otherdeployparams"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Serviceofferingid string `json:"serviceofferingid"` + Templateid string `json:"templateid"` + Userdata string `json:"userdata"` + Zoneid string `json:"zoneid"` } type CreateConditionParams struct { @@ -700,6 +829,9 @@ func (p *CreateConditionParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["projectid"]; found { + u.Set("projectid", v.(string)) + } if v, found := p.p["relationaloperator"]; found { u.Set("relationaloperator", v.(string)) } @@ -755,6 +887,21 @@ func (p *CreateConditionParams) GetDomainid() (string, bool) { return value, ok } +func (p *CreateConditionParams) SetProjectid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectid"] = v +} + +func (p *CreateConditionParams) GetProjectid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectid"].(string) + return value, ok +} + func (p *CreateConditionParams) SetRelationaloperator(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -796,7 +943,7 @@ func (s *AutoScaleService) NewCreateConditionParams(counterid string, relational return p } -// Creates a condition +// Creates a condition for VM auto scaling func (s *AutoScaleService) CreateCondition(p *CreateConditionParams) (*CreateConditionResponse, error) { resp, err := s.cs.newRequest("createCondition", p.toURLValues()) if err != nil { @@ -832,18 +979,20 @@ func (s *AutoScaleService) CreateCondition(p *CreateConditionParams) (*CreateCon } type CreateConditionResponse struct { - Account string `json:"account"` - Counter []string `json:"counter"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Relationaloperator string `json:"relationaloperator"` - Threshold int64 `json:"threshold"` - Zoneid string `json:"zoneid"` + Account string `json:"account"` + Counter string `json:"counter"` + Counterid string `json:"counterid"` + Countername string `json:"countername"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Relationaloperator string `json:"relationaloperator"` + Threshold int64 `json:"threshold"` + Zoneid string `json:"zoneid"` } type CreateCounterParams struct { @@ -858,6 +1007,9 @@ func (p *CreateCounterParams) toURLValues() url.Values { if v, found := p.p["name"]; found { u.Set("name", v.(string)) } + if v, found := p.p["provider"]; found { + u.Set("provider", v.(string)) + } if v, found := p.p["source"]; found { u.Set("source", v.(string)) } @@ -882,6 +1034,21 @@ func (p *CreateCounterParams) GetName() (string, bool) { return value, ok } +func (p *CreateCounterParams) SetProvider(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["provider"] = v +} + +func (p *CreateCounterParams) GetProvider() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["provider"].(string) + return value, ok +} + func (p *CreateCounterParams) SetSource(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -914,16 +1081,17 @@ func (p *CreateCounterParams) GetValue() (string, bool) { // You should always use this function to get a new CreateCounterParams instance, // as then you are sure you have configured all required params -func (s *AutoScaleService) NewCreateCounterParams(name string, source string, value string) *CreateCounterParams { +func (s *AutoScaleService) NewCreateCounterParams(name string, provider string, source string, value string) *CreateCounterParams { p := &CreateCounterParams{} p.p = make(map[string]interface{}) p.p["name"] = name + p.p["provider"] = provider p.p["source"] = source p.p["value"] = value return p } -// Adds metric counter +// Adds metric counter for VM auto scaling func (s *AutoScaleService) CreateCounter(p *CreateCounterParams) (*CreateCounterResponse, error) { resp, err := s.cs.newRequest("createCounter", p.toURLValues()) if err != nil { @@ -963,6 +1131,7 @@ type CreateCounterResponse struct { JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` + Provider string `json:"provider"` Source string `json:"source"` Value string `json:"value"` Zoneid string `json:"zoneid"` @@ -1053,12 +1222,31 @@ func (p *DeleteAutoScaleVmGroupParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["cleanup"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("cleanup", vv) + } if v, found := p.p["id"]; found { u.Set("id", v.(string)) } return u } +func (p *DeleteAutoScaleVmGroupParams) SetCleanup(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cleanup"] = v +} + +func (p *DeleteAutoScaleVmGroupParams) GetCleanup() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cleanup"].(bool) + return value, ok +} + func (p *DeleteAutoScaleVmGroupParams) SetId(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1235,7 +1423,7 @@ func (s *AutoScaleService) NewDeleteConditionParams(id string) *DeleteConditionP return p } -// Removes a condition +// Removes a condition for VM auto scaling func (s *AutoScaleService) DeleteCondition(p *DeleteConditionParams) (*DeleteConditionResponse, error) { resp, err := s.cs.newRequest("deleteCondition", p.toURLValues()) if err != nil { @@ -1311,7 +1499,7 @@ func (s *AutoScaleService) NewDeleteCounterParams(id string) *DeleteCounterParam return p } -// Deletes a counter +// Deletes a counter for VM auto scaling func (s *AutoScaleService) DeleteCounter(p *DeleteCounterParams) (*DeleteCounterResponse, error) { resp, err := s.cs.newRequest("deleteCounter", p.toURLValues()) if err != nil { @@ -1423,23 +1611,34 @@ func (s *AutoScaleService) DisableAutoScaleVmGroup(p *DisableAutoScaleVmGroupPar } type DisableAutoScaleVmGroupResponse struct { - Account string `json:"account"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Fordisplay bool `json:"fordisplay"` - Id string `json:"id"` - Interval int `json:"interval"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Lbruleid string `json:"lbruleid"` - Maxmembers int `json:"maxmembers"` - Minmembers int `json:"minmembers"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Scaledownpolicies []string `json:"scaledownpolicies"` - Scaleuppolicies []string `json:"scaleuppolicies"` - State string `json:"state"` - Vmprofileid string `json:"vmprofileid"` + Account string `json:"account"` + Associatednetworkid string `json:"associatednetworkid"` + Associatednetworkname string `json:"associatednetworkname"` + Availablevirtualmachinecount int `json:"availablevirtualmachinecount"` + Created string `json:"created"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Fordisplay bool `json:"fordisplay"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Interval int `json:"interval"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Lbprovider string `json:"lbprovider"` + Lbruleid string `json:"lbruleid"` + Maxmembers int `json:"maxmembers"` + Minmembers int `json:"minmembers"` + Name string `json:"name"` + Privateport string `json:"privateport"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Publicip string `json:"publicip"` + Publicipid string `json:"publicipid"` + Publicport string `json:"publicport"` + Scaledownpolicies []string `json:"scaledownpolicies"` + Scaleuppolicies []string `json:"scaleuppolicies"` + State string `json:"state"` + Vmprofileid string `json:"vmprofileid"` } type EnableAutoScaleVmGroupParams struct { @@ -1517,23 +1716,34 @@ func (s *AutoScaleService) EnableAutoScaleVmGroup(p *EnableAutoScaleVmGroupParam } type EnableAutoScaleVmGroupResponse struct { - Account string `json:"account"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Fordisplay bool `json:"fordisplay"` - Id string `json:"id"` - Interval int `json:"interval"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Lbruleid string `json:"lbruleid"` - Maxmembers int `json:"maxmembers"` - Minmembers int `json:"minmembers"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Scaledownpolicies []string `json:"scaledownpolicies"` - Scaleuppolicies []string `json:"scaleuppolicies"` - State string `json:"state"` - Vmprofileid string `json:"vmprofileid"` + Account string `json:"account"` + Associatednetworkid string `json:"associatednetworkid"` + Associatednetworkname string `json:"associatednetworkname"` + Availablevirtualmachinecount int `json:"availablevirtualmachinecount"` + Created string `json:"created"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Fordisplay bool `json:"fordisplay"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Interval int `json:"interval"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Lbprovider string `json:"lbprovider"` + Lbruleid string `json:"lbruleid"` + Maxmembers int `json:"maxmembers"` + Minmembers int `json:"minmembers"` + Name string `json:"name"` + Privateport string `json:"privateport"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Publicip string `json:"publicip"` + Publicipid string `json:"publicipid"` + Publicport string `json:"publicport"` + Scaledownpolicies []string `json:"scaledownpolicies"` + Scaleuppolicies []string `json:"scaleuppolicies"` + State string `json:"state"` + Vmprofileid string `json:"vmprofileid"` } type ListAutoScalePoliciesParams struct { @@ -1571,6 +1781,9 @@ func (p *ListAutoScalePoliciesParams) toURLValues() url.Values { 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) @@ -1579,6 +1792,9 @@ func (p *ListAutoScalePoliciesParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("pagesize", vv) } + if v, found := p.p["projectid"]; found { + u.Set("projectid", v.(string)) + } if v, found := p.p["vmgroupid"]; found { u.Set("vmgroupid", v.(string)) } @@ -1705,6 +1921,21 @@ func (p *ListAutoScalePoliciesParams) GetListall() (bool, bool) { return value, ok } +func (p *ListAutoScalePoliciesParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *ListAutoScalePoliciesParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + func (p *ListAutoScalePoliciesParams) SetPage(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1735,6 +1966,21 @@ func (p *ListAutoScalePoliciesParams) GetPagesize() (int, bool) { return value, ok } +func (p *ListAutoScalePoliciesParams) SetProjectid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectid"] = v +} + +func (p *ListAutoScalePoliciesParams) GetProjectid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectid"].(string) + return value, ok +} + func (p *ListAutoScalePoliciesParams) SetVmgroupid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1758,6 +2004,56 @@ func (s *AutoScaleService) NewListAutoScalePoliciesParams() *ListAutoScalePolici return p } +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *AutoScaleService) GetAutoScalePolicyID(name string, opts ...OptionFunc) (string, int, error) { + p := &ListAutoScalePoliciesParams{} + p.p = make(map[string]interface{}) + + p.p["name"] = name + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return "", -1, err + } + } + + l, err := s.ListAutoScalePolicies(p) + if err != nil { + return "", -1, err + } + + if l.Count == 0 { + return "", l.Count, fmt.Errorf("No match found for %s: %+v", name, l) + } + + if l.Count == 1 { + return l.AutoScalePolicies[0].Id, l.Count, nil + } + + if l.Count > 1 { + for _, v := range l.AutoScalePolicies { + if v.Name == name { + return v.Id, l.Count, nil + } + } + } + return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", name, l) +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *AutoScaleService) GetAutoScalePolicyByName(name string, opts ...OptionFunc) (*AutoScalePolicy, int, error) { + id, count, err := s.GetAutoScalePolicyID(name, opts...) + if err != nil { + return nil, count, err + } + + r, count, err := s.GetAutoScalePolicyByID(id, opts...) + if err != nil { + return nil, count, err + } + return r, count, nil +} + // This is a courtesy helper function, which in some cases may not work as expected! func (s *AutoScaleService) GetAutoScalePolicyByID(id string, opts ...OptionFunc) (*AutoScalePolicy, int, error) { p := &ListAutoScalePoliciesParams{} @@ -1821,6 +2117,7 @@ type AutoScalePolicy struct { Id string `json:"id"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Name string `json:"name"` Project string `json:"project"` Projectid string `json:"projectid"` Quiettime int `json:"quiettime"` @@ -1862,6 +2159,9 @@ func (p *ListAutoScaleVmGroupsParams) toURLValues() url.Values { 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) @@ -2005,6 +2305,21 @@ func (p *ListAutoScaleVmGroupsParams) GetListall() (bool, bool) { return value, ok } +func (p *ListAutoScaleVmGroupsParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *ListAutoScaleVmGroupsParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + func (p *ListAutoScaleVmGroupsParams) SetPage(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2103,6 +2418,56 @@ func (s *AutoScaleService) NewListAutoScaleVmGroupsParams() *ListAutoScaleVmGrou return p } +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *AutoScaleService) GetAutoScaleVmGroupID(name string, opts ...OptionFunc) (string, int, error) { + p := &ListAutoScaleVmGroupsParams{} + p.p = make(map[string]interface{}) + + p.p["name"] = name + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return "", -1, err + } + } + + l, err := s.ListAutoScaleVmGroups(p) + if err != nil { + return "", -1, err + } + + if l.Count == 0 { + return "", l.Count, fmt.Errorf("No match found for %s: %+v", name, l) + } + + if l.Count == 1 { + return l.AutoScaleVmGroups[0].Id, l.Count, nil + } + + if l.Count > 1 { + for _, v := range l.AutoScaleVmGroups { + if v.Name == name { + return v.Id, l.Count, nil + } + } + } + return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", name, l) +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *AutoScaleService) GetAutoScaleVmGroupByName(name string, opts ...OptionFunc) (*AutoScaleVmGroup, int, error) { + id, count, err := s.GetAutoScaleVmGroupID(name, opts...) + if err != nil { + return nil, count, err + } + + r, count, err := s.GetAutoScaleVmGroupByID(id, opts...) + if err != nil { + return nil, count, err + } + return r, count, nil +} + // This is a courtesy helper function, which in some cases may not work as expected! func (s *AutoScaleService) GetAutoScaleVmGroupByID(id string, opts ...OptionFunc) (*AutoScaleVmGroup, int, error) { p := &ListAutoScaleVmGroupsParams{} @@ -2157,23 +2522,34 @@ type ListAutoScaleVmGroupsResponse struct { } type AutoScaleVmGroup struct { - Account string `json:"account"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Fordisplay bool `json:"fordisplay"` - Id string `json:"id"` - Interval int `json:"interval"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Lbruleid string `json:"lbruleid"` - Maxmembers int `json:"maxmembers"` - Minmembers int `json:"minmembers"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Scaledownpolicies []string `json:"scaledownpolicies"` - Scaleuppolicies []string `json:"scaleuppolicies"` - State string `json:"state"` - Vmprofileid string `json:"vmprofileid"` + Account string `json:"account"` + Associatednetworkid string `json:"associatednetworkid"` + Associatednetworkname string `json:"associatednetworkname"` + Availablevirtualmachinecount int `json:"availablevirtualmachinecount"` + Created string `json:"created"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Fordisplay bool `json:"fordisplay"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Interval int `json:"interval"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Lbprovider string `json:"lbprovider"` + Lbruleid string `json:"lbruleid"` + Maxmembers int `json:"maxmembers"` + Minmembers int `json:"minmembers"` + Name string `json:"name"` + Privateport string `json:"privateport"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Publicip string `json:"publicip"` + Publicipid string `json:"publicipid"` + Publicport string `json:"publicport"` + Scaledownpolicies []string `json:"scaledownpolicies"` + Scaleuppolicies []string `json:"scaleuppolicies"` + State string `json:"state"` + Vmprofileid string `json:"vmprofileid"` } type ListAutoScaleVmProfilesParams struct { @@ -2507,21 +2883,22 @@ type ListAutoScaleVmProfilesResponse struct { } type AutoScaleVmProfile struct { - Account string `json:"account"` - Autoscaleuserid string `json:"autoscaleuserid"` - Destroyvmgraceperiod int `json:"destroyvmgraceperiod"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Fordisplay bool `json:"fordisplay"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Otherdeployparams string `json:"otherdeployparams"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Serviceofferingid string `json:"serviceofferingid"` - Templateid string `json:"templateid"` - Zoneid string `json:"zoneid"` + Account string `json:"account"` + Autoscaleuserid string `json:"autoscaleuserid"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Expungevmgraceperiod int `json:"expungevmgraceperiod"` + Fordisplay bool `json:"fordisplay"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Otherdeployparams map[string]string `json:"otherdeployparams"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Serviceofferingid string `json:"serviceofferingid"` + Templateid string `json:"templateid"` + Userdata string `json:"userdata"` + Zoneid string `json:"zoneid"` } type ListConditionsParams struct { @@ -2567,6 +2944,9 @@ func (p *ListConditionsParams) toURLValues() url.Values { if v, found := p.p["policyid"]; found { u.Set("policyid", v.(string)) } + if v, found := p.p["projectid"]; found { + u.Set("projectid", v.(string)) + } return u } @@ -2720,6 +3100,21 @@ func (p *ListConditionsParams) GetPolicyid() (string, bool) { return value, ok } +func (p *ListConditionsParams) SetProjectid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectid"] = v +} + +func (p *ListConditionsParams) GetProjectid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectid"].(string) + return value, ok +} + // You should always use this function to get a new ListConditionsParams instance, // as then you are sure you have configured all required params func (s *AutoScaleService) NewListConditionsParams() *ListConditionsParams { @@ -2761,7 +3156,7 @@ func (s *AutoScaleService) GetConditionByID(id string, opts ...OptionFunc) (*Con return nil, l.Count, fmt.Errorf("There is more then one result for Condition UUID: %s!", id) } -// List Conditions for the specific user +// List Conditions for VM auto scaling func (s *AutoScaleService) ListConditions(p *ListConditionsParams) (*ListConditionsResponse, error) { resp, err := s.cs.newRequest("listConditions", p.toURLValues()) if err != nil { @@ -2782,18 +3177,20 @@ type ListConditionsResponse struct { } type Condition struct { - Account string `json:"account"` - Counter []string `json:"counter"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Relationaloperator string `json:"relationaloperator"` - Threshold int64 `json:"threshold"` - Zoneid string `json:"zoneid"` + Account string `json:"account"` + Counter string `json:"counter"` + Counterid string `json:"counterid"` + Countername string `json:"countername"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Relationaloperator string `json:"relationaloperator"` + Threshold int64 `json:"threshold"` + Zoneid string `json:"zoneid"` } type ListCountersParams struct { @@ -2822,6 +3219,9 @@ func (p *ListCountersParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("pagesize", vv) } + if v, found := p.p["provider"]; found { + u.Set("provider", v.(string)) + } if v, found := p.p["source"]; found { u.Set("source", v.(string)) } @@ -2903,6 +3303,21 @@ func (p *ListCountersParams) GetPagesize() (int, bool) { return value, ok } +func (p *ListCountersParams) SetProvider(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["provider"] = v +} + +func (p *ListCountersParams) GetProvider() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["provider"].(string) + return value, ok +} + func (p *ListCountersParams) SetSource(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3009,7 +3424,7 @@ func (s *AutoScaleService) GetCounterByID(id string, opts ...OptionFunc) (*Count return nil, l.Count, fmt.Errorf("There is more then one result for Counter UUID: %s!", id) } -// List the counters +// List the counters for VM auto scaling func (s *AutoScaleService) ListCounters(p *ListCountersParams) (*ListCountersResponse, error) { resp, err := s.cs.newRequest("listCounters", p.toURLValues()) if err != nil { @@ -3034,6 +3449,7 @@ type Counter struct { JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` + Provider string `json:"provider"` Source string `json:"source"` Value string `json:"value"` Zoneid string `json:"zoneid"` @@ -3059,6 +3475,9 @@ func (p *UpdateAutoScalePolicyParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } if v, found := p.p["quiettime"]; found { vv := strconv.Itoa(v.(int)) u.Set("quiettime", vv) @@ -3111,6 +3530,21 @@ func (p *UpdateAutoScalePolicyParams) GetId() (string, bool) { return value, ok } +func (p *UpdateAutoScalePolicyParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *UpdateAutoScalePolicyParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + func (p *UpdateAutoScalePolicyParams) SetQuiettime(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3180,6 +3614,7 @@ type UpdateAutoScalePolicyResponse struct { Id string `json:"id"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Name string `json:"name"` Project string `json:"project"` Projectid string `json:"projectid"` Quiettime int `json:"quiettime"` @@ -3216,6 +3651,9 @@ func (p *UpdateAutoScaleVmGroupParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("minmembers", vv) } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } if v, found := p.p["scaledownpolicyids"]; found { vv := strings.Join(v.([]string), ",") u.Set("scaledownpolicyids", vv) @@ -3317,6 +3755,21 @@ func (p *UpdateAutoScaleVmGroupParams) GetMinmembers() (int, bool) { return value, ok } +func (p *UpdateAutoScaleVmGroupParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *UpdateAutoScaleVmGroupParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + func (p *UpdateAutoScaleVmGroupParams) SetScaledownpolicyids(v []string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3392,23 +3845,34 @@ func (s *AutoScaleService) UpdateAutoScaleVmGroup(p *UpdateAutoScaleVmGroupParam } type UpdateAutoScaleVmGroupResponse struct { - Account string `json:"account"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Fordisplay bool `json:"fordisplay"` - Id string `json:"id"` - Interval int `json:"interval"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Lbruleid string `json:"lbruleid"` - Maxmembers int `json:"maxmembers"` - Minmembers int `json:"minmembers"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Scaledownpolicies []string `json:"scaledownpolicies"` - Scaleuppolicies []string `json:"scaleuppolicies"` - State string `json:"state"` - Vmprofileid string `json:"vmprofileid"` + Account string `json:"account"` + Associatednetworkid string `json:"associatednetworkid"` + Associatednetworkname string `json:"associatednetworkname"` + Availablevirtualmachinecount int `json:"availablevirtualmachinecount"` + Created string `json:"created"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Fordisplay bool `json:"fordisplay"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Interval int `json:"interval"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Lbprovider string `json:"lbprovider"` + Lbruleid string `json:"lbruleid"` + Maxmembers int `json:"maxmembers"` + Minmembers int `json:"minmembers"` + Name string `json:"name"` + Privateport string `json:"privateport"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Publicip string `json:"publicip"` + Publicipid string `json:"publicipid"` + Publicport string `json:"publicport"` + Scaledownpolicies []string `json:"scaledownpolicies"` + Scaleuppolicies []string `json:"scaleuppolicies"` + State string `json:"state"` + Vmprofileid string `json:"vmprofileid"` } type UpdateAutoScaleVmProfileParams struct { @@ -3433,9 +3897,9 @@ func (p *UpdateAutoScaleVmProfileParams) toURLValues() url.Values { if v, found := p.p["customid"]; found { u.Set("customid", v.(string)) } - if v, found := p.p["destroyvmgraceperiod"]; found { + if v, found := p.p["expungevmgraceperiod"]; found { vv := strconv.Itoa(v.(int)) - u.Set("destroyvmgraceperiod", vv) + u.Set("expungevmgraceperiod", vv) } if v, found := p.p["fordisplay"]; found { vv := strconv.FormatBool(v.(bool)) @@ -3444,9 +3908,22 @@ func (p *UpdateAutoScaleVmProfileParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["otherdeployparams"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("otherdeployparams[%d].key", i), k) + u.Set(fmt.Sprintf("otherdeployparams[%d].value", i), m[k]) + } + } + if v, found := p.p["serviceofferingid"]; found { + u.Set("serviceofferingid", v.(string)) + } if v, found := p.p["templateid"]; found { u.Set("templateid", v.(string)) } + if v, found := p.p["userdata"]; found { + u.Set("userdata", v.(string)) + } return u } @@ -3495,18 +3972,18 @@ func (p *UpdateAutoScaleVmProfileParams) GetCustomid() (string, bool) { return value, ok } -func (p *UpdateAutoScaleVmProfileParams) SetDestroyvmgraceperiod(v int) { +func (p *UpdateAutoScaleVmProfileParams) SetExpungevmgraceperiod(v int) { if p.p == nil { p.p = make(map[string]interface{}) } - p.p["destroyvmgraceperiod"] = v + p.p["expungevmgraceperiod"] = v } -func (p *UpdateAutoScaleVmProfileParams) GetDestroyvmgraceperiod() (int, bool) { +func (p *UpdateAutoScaleVmProfileParams) GetExpungevmgraceperiod() (int, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["destroyvmgraceperiod"].(int) + value, ok := p.p["expungevmgraceperiod"].(int) return value, ok } @@ -3540,6 +4017,36 @@ func (p *UpdateAutoScaleVmProfileParams) GetId() (string, bool) { return value, ok } +func (p *UpdateAutoScaleVmProfileParams) SetOtherdeployparams(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["otherdeployparams"] = v +} + +func (p *UpdateAutoScaleVmProfileParams) GetOtherdeployparams() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["otherdeployparams"].(map[string]string) + return value, ok +} + +func (p *UpdateAutoScaleVmProfileParams) SetServiceofferingid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["serviceofferingid"] = v +} + +func (p *UpdateAutoScaleVmProfileParams) GetServiceofferingid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["serviceofferingid"].(string) + return value, ok +} + func (p *UpdateAutoScaleVmProfileParams) SetTemplateid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3555,6 +4062,21 @@ func (p *UpdateAutoScaleVmProfileParams) GetTemplateid() (string, bool) { return value, ok } +func (p *UpdateAutoScaleVmProfileParams) SetUserdata(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdata"] = v +} + +func (p *UpdateAutoScaleVmProfileParams) GetUserdata() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdata"].(string) + return value, ok +} + // You should always use this function to get a new UpdateAutoScaleVmProfileParams instance, // as then you are sure you have configured all required params func (s *AutoScaleService) NewUpdateAutoScaleVmProfileParams(id string) *UpdateAutoScaleVmProfileParams { @@ -3600,19 +4122,20 @@ func (s *AutoScaleService) UpdateAutoScaleVmProfile(p *UpdateAutoScaleVmProfileP } type UpdateAutoScaleVmProfileResponse struct { - Account string `json:"account"` - Autoscaleuserid string `json:"autoscaleuserid"` - Destroyvmgraceperiod int `json:"destroyvmgraceperiod"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Fordisplay bool `json:"fordisplay"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Otherdeployparams string `json:"otherdeployparams"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Serviceofferingid string `json:"serviceofferingid"` - Templateid string `json:"templateid"` - Zoneid string `json:"zoneid"` + Account string `json:"account"` + Autoscaleuserid string `json:"autoscaleuserid"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Expungevmgraceperiod int `json:"expungevmgraceperiod"` + Fordisplay bool `json:"fordisplay"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Otherdeployparams map[string]string `json:"otherdeployparams"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Serviceofferingid string `json:"serviceofferingid"` + Templateid string `json:"templateid"` + Userdata string `json:"userdata"` + Zoneid string `json:"zoneid"` } diff --git a/cloudstack/AutoScaleService_mock.go b/cloudstack/AutoScaleService_mock.go index b189119d..fe59d70f 100644 --- a/cloudstack/AutoScaleService_mock.go +++ b/cloudstack/AutoScaleService_mock.go @@ -253,6 +253,48 @@ func (mr *MockAutoScaleServiceIfaceMockRecorder) GetAutoScalePolicyByID(id inter return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetAutoScalePolicyByID", reflect.TypeOf((*MockAutoScaleServiceIface)(nil).GetAutoScalePolicyByID), varargs...) } +// GetAutoScalePolicyByName mocks base method. +func (m *MockAutoScaleServiceIface) GetAutoScalePolicyByName(name string, opts ...OptionFunc) (*AutoScalePolicy, int, error) { + m.ctrl.T.Helper() + varargs := []interface{}{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetAutoScalePolicyByName", varargs...) + ret0, _ := ret[0].(*AutoScalePolicy) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetAutoScalePolicyByName indicates an expected call of GetAutoScalePolicyByName. +func (mr *MockAutoScaleServiceIfaceMockRecorder) GetAutoScalePolicyByName(name interface{}, opts ...interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]interface{}{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetAutoScalePolicyByName", reflect.TypeOf((*MockAutoScaleServiceIface)(nil).GetAutoScalePolicyByName), varargs...) +} + +// GetAutoScalePolicyID mocks base method. +func (m *MockAutoScaleServiceIface) GetAutoScalePolicyID(name string, opts ...OptionFunc) (string, int, error) { + m.ctrl.T.Helper() + varargs := []interface{}{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetAutoScalePolicyID", varargs...) + ret0, _ := ret[0].(string) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetAutoScalePolicyID indicates an expected call of GetAutoScalePolicyID. +func (mr *MockAutoScaleServiceIfaceMockRecorder) GetAutoScalePolicyID(name interface{}, opts ...interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]interface{}{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetAutoScalePolicyID", reflect.TypeOf((*MockAutoScaleServiceIface)(nil).GetAutoScalePolicyID), varargs...) +} + // GetAutoScaleVmGroupByID mocks base method. func (m *MockAutoScaleServiceIface) GetAutoScaleVmGroupByID(id string, opts ...OptionFunc) (*AutoScaleVmGroup, int, error) { m.ctrl.T.Helper() @@ -274,6 +316,48 @@ func (mr *MockAutoScaleServiceIfaceMockRecorder) GetAutoScaleVmGroupByID(id inte return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetAutoScaleVmGroupByID", reflect.TypeOf((*MockAutoScaleServiceIface)(nil).GetAutoScaleVmGroupByID), varargs...) } +// GetAutoScaleVmGroupByName mocks base method. +func (m *MockAutoScaleServiceIface) GetAutoScaleVmGroupByName(name string, opts ...OptionFunc) (*AutoScaleVmGroup, int, error) { + m.ctrl.T.Helper() + varargs := []interface{}{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetAutoScaleVmGroupByName", varargs...) + ret0, _ := ret[0].(*AutoScaleVmGroup) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetAutoScaleVmGroupByName indicates an expected call of GetAutoScaleVmGroupByName. +func (mr *MockAutoScaleServiceIfaceMockRecorder) GetAutoScaleVmGroupByName(name interface{}, opts ...interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]interface{}{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetAutoScaleVmGroupByName", reflect.TypeOf((*MockAutoScaleServiceIface)(nil).GetAutoScaleVmGroupByName), varargs...) +} + +// GetAutoScaleVmGroupID mocks base method. +func (m *MockAutoScaleServiceIface) GetAutoScaleVmGroupID(name string, opts ...OptionFunc) (string, int, error) { + m.ctrl.T.Helper() + varargs := []interface{}{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetAutoScaleVmGroupID", varargs...) + ret0, _ := ret[0].(string) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetAutoScaleVmGroupID indicates an expected call of GetAutoScaleVmGroupID. +func (mr *MockAutoScaleServiceIfaceMockRecorder) GetAutoScaleVmGroupID(name interface{}, opts ...interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]interface{}{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetAutoScaleVmGroupID", reflect.TypeOf((*MockAutoScaleServiceIface)(nil).GetAutoScaleVmGroupID), varargs...) +} + // GetAutoScaleVmProfileByID mocks base method. func (m *MockAutoScaleServiceIface) GetAutoScaleVmProfileByID(id string, opts ...OptionFunc) (*AutoScaleVmProfile, int, error) { m.ctrl.T.Helper() @@ -511,17 +595,17 @@ func (mr *MockAutoScaleServiceIfaceMockRecorder) NewCreateConditionParams(counte } // NewCreateCounterParams mocks base method. -func (m *MockAutoScaleServiceIface) NewCreateCounterParams(name, source, value string) *CreateCounterParams { +func (m *MockAutoScaleServiceIface) NewCreateCounterParams(name, provider, source, value string) *CreateCounterParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewCreateCounterParams", name, source, value) + ret := m.ctrl.Call(m, "NewCreateCounterParams", name, provider, source, value) ret0, _ := ret[0].(*CreateCounterParams) return ret0 } // NewCreateCounterParams indicates an expected call of NewCreateCounterParams. -func (mr *MockAutoScaleServiceIfaceMockRecorder) NewCreateCounterParams(name, source, value interface{}) *gomock.Call { +func (mr *MockAutoScaleServiceIfaceMockRecorder) NewCreateCounterParams(name, provider, source, value interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateCounterParams", reflect.TypeOf((*MockAutoScaleServiceIface)(nil).NewCreateCounterParams), name, source, value) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateCounterParams", reflect.TypeOf((*MockAutoScaleServiceIface)(nil).NewCreateCounterParams), name, provider, source, value) } // NewDeleteAutoScalePolicyParams mocks base method. diff --git a/cloudstack/BrocadeVCSService.go b/cloudstack/BrocadeVCSService.go index e647785e..03eb5cf6 100644 --- a/cloudstack/BrocadeVCSService.go +++ b/cloudstack/BrocadeVCSService.go @@ -434,6 +434,8 @@ type BrocadeVcsDeviceNetwork struct { Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` Ip6cidr string `json:"ip6cidr"` + Ip6dns1 string `json:"ip6dns1"` + Ip6dns2 string `json:"ip6dns2"` Ip6gateway string `json:"ip6gateway"` Ip6routes []interface{} `json:"ip6routes"` Ip6routing string `json:"ip6routing"` @@ -452,8 +454,10 @@ type BrocadeVcsDeviceNetwork struct { Networkofferingid string `json:"networkofferingid"` Networkofferingname string `json:"networkofferingname"` Physicalnetworkid string `json:"physicalnetworkid"` + Privatemtu int `json:"privatemtu"` Project string `json:"project"` Projectid string `json:"projectid"` + Publicmtu int `json:"publicmtu"` Receivedbytes int64 `json:"receivedbytes"` Redundantrouter bool `json:"redundantrouter"` Related string `json:"related"` @@ -465,8 +469,10 @@ type BrocadeVcsDeviceNetwork struct { State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` + Supportsvmautoscaling bool `json:"supportsvmautoscaling"` Tags []Tags `json:"tags"` Traffictype string `json:"traffictype"` + Tungstenvirtualrouteruuid string `json:"tungstenvirtualrouteruuid"` Type string `json:"type"` Vlan string `json:"vlan"` Vpcid string `json:"vpcid"` diff --git a/cloudstack/ConfigurationService.go b/cloudstack/ConfigurationService.go index 80394440..fc1e5b33 100644 --- a/cloudstack/ConfigurationService.go +++ b/cloudstack/ConfigurationService.go @@ -90,6 +90,10 @@ type Capability struct { Customdiskofferingminsize int64 `json:"customdiskofferingminsize"` Defaultuipagesize int64 `json:"defaultuipagesize"` Dynamicrolesenabled bool `json:"dynamicrolesenabled"` + Instancesdisksstatsretentionenabled bool `json:"instancesdisksstatsretentionenabled"` + Instancesdisksstatsretentiontime int `json:"instancesdisksstatsretentiontime"` + Instancesstatsretentiontime int `json:"instancesstatsretentiontime"` + Instancesstatsuseronly bool `json:"instancesstatsuseronly"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Kubernetesclusterexperimentalfeaturesenabled bool `json:"kubernetesclusterexperimentalfeaturesenabled"` @@ -123,6 +127,9 @@ func (p *ListConfigurationsParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["group"]; found { + u.Set("group", v.(string)) + } if v, found := p.p["imagestoreuuid"]; found { u.Set("imagestoreuuid", v.(string)) } @@ -140,9 +147,15 @@ func (p *ListConfigurationsParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("pagesize", vv) } + if v, found := p.p["parent"]; found { + u.Set("parent", v.(string)) + } if v, found := p.p["storageid"]; found { u.Set("storageid", v.(string)) } + if v, found := p.p["subgroup"]; found { + u.Set("subgroup", v.(string)) + } if v, found := p.p["zoneid"]; found { u.Set("zoneid", v.(string)) } @@ -209,6 +222,21 @@ func (p *ListConfigurationsParams) GetDomainid() (string, bool) { return value, ok } +func (p *ListConfigurationsParams) SetGroup(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["group"] = v +} + +func (p *ListConfigurationsParams) GetGroup() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["group"].(string) + return value, ok +} + func (p *ListConfigurationsParams) SetImagestoreuuid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -284,6 +312,21 @@ func (p *ListConfigurationsParams) GetPagesize() (int, bool) { return value, ok } +func (p *ListConfigurationsParams) SetParent(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["parent"] = v +} + +func (p *ListConfigurationsParams) GetParent() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["parent"].(string) + return value, ok +} + func (p *ListConfigurationsParams) SetStorageid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -299,6 +342,21 @@ func (p *ListConfigurationsParams) GetStorageid() (string, bool) { return value, ok } +func (p *ListConfigurationsParams) SetSubgroup(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["subgroup"] = v +} + +func (p *ListConfigurationsParams) GetSubgroup() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["subgroup"].(string) + return value, ok +} + func (p *ListConfigurationsParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -343,15 +401,23 @@ type ListConfigurationsResponse struct { } type Configuration struct { - Category string `json:"category"` - Description string `json:"description"` - Id int64 `json:"id"` - Isdynamic bool `json:"isdynamic"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Scope string `json:"scope"` - Value string `json:"value"` + Category string `json:"category"` + Component string `json:"component"` + Defaultvalue string `json:"defaultvalue"` + Description string `json:"description"` + Displaytext string `json:"displaytext"` + Group string `json:"group"` + Id int64 `json:"id"` + Isdynamic bool `json:"isdynamic"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Options string `json:"options"` + Parent string `json:"parent"` + Scope string `json:"scope"` + Subgroup string `json:"subgroup"` + Type string `json:"type"` + Value string `json:"value"` } type ListDeploymentPlannersParams struct { @@ -641,15 +707,23 @@ func (s *ConfigurationService) UpdateConfiguration(p *UpdateConfigurationParams) } type UpdateConfigurationResponse struct { - Category string `json:"category"` - Description string `json:"description"` - Id int64 `json:"id"` - Isdynamic bool `json:"isdynamic"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Scope string `json:"scope"` - Value string `json:"value"` + Category string `json:"category"` + Component string `json:"component"` + Defaultvalue string `json:"defaultvalue"` + Description string `json:"description"` + Displaytext string `json:"displaytext"` + Group string `json:"group"` + Id int64 `json:"id"` + Isdynamic bool `json:"isdynamic"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Options string `json:"options"` + Parent string `json:"parent"` + Scope string `json:"scope"` + Subgroup string `json:"subgroup"` + Type string `json:"type"` + Value string `json:"value"` } type ResetConfigurationParams struct { @@ -815,13 +889,21 @@ func (s *ConfigurationService) ResetConfiguration(p *ResetConfigurationParams) ( } type ResetConfigurationResponse struct { - Category string `json:"category"` - Description string `json:"description"` - Id int64 `json:"id"` - Isdynamic bool `json:"isdynamic"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Scope string `json:"scope"` - Value string `json:"value"` + Category string `json:"category"` + Component string `json:"component"` + Defaultvalue string `json:"defaultvalue"` + Description string `json:"description"` + Displaytext string `json:"displaytext"` + Group string `json:"group"` + Id int64 `json:"id"` + Isdynamic bool `json:"isdynamic"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Options string `json:"options"` + Parent string `json:"parent"` + Scope string `json:"scope"` + Subgroup string `json:"subgroup"` + Type string `json:"type"` + Value string `json:"value"` } diff --git a/cloudstack/DiskOfferingService.go b/cloudstack/DiskOfferingService.go index b24d0b39..f7100a8f 100644 --- a/cloudstack/DiskOfferingService.go +++ b/cloudstack/DiskOfferingService.go @@ -110,6 +110,10 @@ func (p *CreateDiskOfferingParams) toURLValues() url.Values { vv := strings.Join(v.([]string), ",") u.Set("domainid", vv) } + if v, found := p.p["encrypt"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("encrypt", vv) + } if v, found := p.p["hypervisorsnapshotreserve"]; found { vv := strconv.Itoa(v.(int)) u.Set("hypervisorsnapshotreserve", vv) @@ -393,6 +397,21 @@ func (p *CreateDiskOfferingParams) GetDomainid() ([]string, bool) { return value, ok } +func (p *CreateDiskOfferingParams) SetEncrypt(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["encrypt"] = v +} + +func (p *CreateDiskOfferingParams) GetEncrypt() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["encrypt"].(bool) + return value, ok +} + func (p *CreateDiskOfferingParams) SetHypervisorsnapshotreserve(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -648,42 +667,44 @@ func (s *DiskOfferingService) CreateDiskOffering(p *CreateDiskOfferingParams) (* } type CreateDiskOfferingResponse struct { - CacheMode string `json:"cacheMode"` - Created string `json:"created"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesReadRateMax int64 `json:"diskBytesReadRateMax"` - DiskBytesReadRateMaxLength int64 `json:"diskBytesReadRateMaxLength"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskBytesWriteRateMax int64 `json:"diskBytesWriteRateMax"` - DiskBytesWriteRateMaxLength int64 `json:"diskBytesWriteRateMaxLength"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsReadRateMax int64 `json:"diskIopsReadRateMax"` - DiskIopsReadRateMaxLength int64 `json:"diskIopsReadRateMaxLength"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - DiskIopsWriteRateMax int64 `json:"diskIopsWriteRateMax"` - DiskIopsWriteRateMaxLength int64 `json:"diskIopsWriteRateMaxLength"` - Disksize int64 `json:"disksize"` - Disksizestrictness bool `json:"disksizestrictness"` - Displayoffering bool `json:"displayoffering"` - Displaytext string `json:"displaytext"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Hasannotations bool `json:"hasannotations"` - Hypervisorsnapshotreserve int `json:"hypervisorsnapshotreserve"` - Id string `json:"id"` - Iscustomized bool `json:"iscustomized"` - Iscustomizediops bool `json:"iscustomizediops"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Provisioningtype string `json:"provisioningtype"` - Storagetype string `json:"storagetype"` - Tags string `json:"tags"` - Vspherestoragepolicy string `json:"vspherestoragepolicy"` - Zone string `json:"zone"` - Zoneid string `json:"zoneid"` + CacheMode string `json:"cacheMode"` + Created string `json:"created"` + Details map[string]string `json:"details"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesReadRateMax int64 `json:"diskBytesReadRateMax"` + DiskBytesReadRateMaxLength int64 `json:"diskBytesReadRateMaxLength"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskBytesWriteRateMax int64 `json:"diskBytesWriteRateMax"` + DiskBytesWriteRateMaxLength int64 `json:"diskBytesWriteRateMaxLength"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsReadRateMax int64 `json:"diskIopsReadRateMax"` + DiskIopsReadRateMaxLength int64 `json:"diskIopsReadRateMaxLength"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + DiskIopsWriteRateMax int64 `json:"diskIopsWriteRateMax"` + DiskIopsWriteRateMaxLength int64 `json:"diskIopsWriteRateMaxLength"` + Disksize int64 `json:"disksize"` + Disksizestrictness bool `json:"disksizestrictness"` + Displayoffering bool `json:"displayoffering"` + Displaytext string `json:"displaytext"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Encrypt bool `json:"encrypt"` + Hasannotations bool `json:"hasannotations"` + Hypervisorsnapshotreserve int `json:"hypervisorsnapshotreserve"` + Id string `json:"id"` + Iscustomized bool `json:"iscustomized"` + Iscustomizediops bool `json:"iscustomizediops"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Provisioningtype string `json:"provisioningtype"` + Storagetype string `json:"storagetype"` + Tags string `json:"tags"` + Vspherestoragepolicy string `json:"vspherestoragepolicy"` + Zone string `json:"zone"` + Zoneid string `json:"zoneid"` } type DeleteDiskOfferingParams struct { @@ -786,6 +807,10 @@ func (p *ListDiskOfferingsParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["encrypt"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("encrypt", vv) + } if v, found := p.p["id"]; found { u.Set("id", v.(string)) } @@ -838,6 +863,21 @@ func (p *ListDiskOfferingsParams) GetDomainid() (string, bool) { return value, ok } +func (p *ListDiskOfferingsParams) SetEncrypt(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["encrypt"] = v +} + +func (p *ListDiskOfferingsParams) GetEncrypt() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["encrypt"].(bool) + return value, ok +} + func (p *ListDiskOfferingsParams) SetId(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1100,42 +1140,44 @@ type ListDiskOfferingsResponse struct { } type DiskOffering struct { - CacheMode string `json:"cacheMode"` - Created string `json:"created"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesReadRateMax int64 `json:"diskBytesReadRateMax"` - DiskBytesReadRateMaxLength int64 `json:"diskBytesReadRateMaxLength"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskBytesWriteRateMax int64 `json:"diskBytesWriteRateMax"` - DiskBytesWriteRateMaxLength int64 `json:"diskBytesWriteRateMaxLength"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsReadRateMax int64 `json:"diskIopsReadRateMax"` - DiskIopsReadRateMaxLength int64 `json:"diskIopsReadRateMaxLength"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - DiskIopsWriteRateMax int64 `json:"diskIopsWriteRateMax"` - DiskIopsWriteRateMaxLength int64 `json:"diskIopsWriteRateMaxLength"` - Disksize int64 `json:"disksize"` - Disksizestrictness bool `json:"disksizestrictness"` - Displayoffering bool `json:"displayoffering"` - Displaytext string `json:"displaytext"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Hasannotations bool `json:"hasannotations"` - Hypervisorsnapshotreserve int `json:"hypervisorsnapshotreserve"` - Id string `json:"id"` - Iscustomized bool `json:"iscustomized"` - Iscustomizediops bool `json:"iscustomizediops"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Provisioningtype string `json:"provisioningtype"` - Storagetype string `json:"storagetype"` - Tags string `json:"tags"` - Vspherestoragepolicy string `json:"vspherestoragepolicy"` - Zone string `json:"zone"` - Zoneid string `json:"zoneid"` + CacheMode string `json:"cacheMode"` + Created string `json:"created"` + Details map[string]string `json:"details"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesReadRateMax int64 `json:"diskBytesReadRateMax"` + DiskBytesReadRateMaxLength int64 `json:"diskBytesReadRateMaxLength"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskBytesWriteRateMax int64 `json:"diskBytesWriteRateMax"` + DiskBytesWriteRateMaxLength int64 `json:"diskBytesWriteRateMaxLength"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsReadRateMax int64 `json:"diskIopsReadRateMax"` + DiskIopsReadRateMaxLength int64 `json:"diskIopsReadRateMaxLength"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + DiskIopsWriteRateMax int64 `json:"diskIopsWriteRateMax"` + DiskIopsWriteRateMaxLength int64 `json:"diskIopsWriteRateMaxLength"` + Disksize int64 `json:"disksize"` + Disksizestrictness bool `json:"disksizestrictness"` + Displayoffering bool `json:"displayoffering"` + Displaytext string `json:"displaytext"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Encrypt bool `json:"encrypt"` + Hasannotations bool `json:"hasannotations"` + Hypervisorsnapshotreserve int `json:"hypervisorsnapshotreserve"` + Id string `json:"id"` + Iscustomized bool `json:"iscustomized"` + Iscustomizediops bool `json:"iscustomizediops"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Provisioningtype string `json:"provisioningtype"` + Storagetype string `json:"storagetype"` + Tags string `json:"tags"` + Vspherestoragepolicy string `json:"vspherestoragepolicy"` + Zone string `json:"zone"` + Zoneid string `json:"zoneid"` } type UpdateDiskOfferingParams struct { @@ -1567,40 +1609,42 @@ func (s *DiskOfferingService) UpdateDiskOffering(p *UpdateDiskOfferingParams) (* } type UpdateDiskOfferingResponse struct { - CacheMode string `json:"cacheMode"` - Created string `json:"created"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesReadRateMax int64 `json:"diskBytesReadRateMax"` - DiskBytesReadRateMaxLength int64 `json:"diskBytesReadRateMaxLength"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskBytesWriteRateMax int64 `json:"diskBytesWriteRateMax"` - DiskBytesWriteRateMaxLength int64 `json:"diskBytesWriteRateMaxLength"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsReadRateMax int64 `json:"diskIopsReadRateMax"` - DiskIopsReadRateMaxLength int64 `json:"diskIopsReadRateMaxLength"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - DiskIopsWriteRateMax int64 `json:"diskIopsWriteRateMax"` - DiskIopsWriteRateMaxLength int64 `json:"diskIopsWriteRateMaxLength"` - Disksize int64 `json:"disksize"` - Disksizestrictness bool `json:"disksizestrictness"` - Displayoffering bool `json:"displayoffering"` - Displaytext string `json:"displaytext"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Hasannotations bool `json:"hasannotations"` - Hypervisorsnapshotreserve int `json:"hypervisorsnapshotreserve"` - Id string `json:"id"` - Iscustomized bool `json:"iscustomized"` - Iscustomizediops bool `json:"iscustomizediops"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Provisioningtype string `json:"provisioningtype"` - Storagetype string `json:"storagetype"` - Tags string `json:"tags"` - Vspherestoragepolicy string `json:"vspherestoragepolicy"` - Zone string `json:"zone"` - Zoneid string `json:"zoneid"` + CacheMode string `json:"cacheMode"` + Created string `json:"created"` + Details map[string]string `json:"details"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesReadRateMax int64 `json:"diskBytesReadRateMax"` + DiskBytesReadRateMaxLength int64 `json:"diskBytesReadRateMaxLength"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskBytesWriteRateMax int64 `json:"diskBytesWriteRateMax"` + DiskBytesWriteRateMaxLength int64 `json:"diskBytesWriteRateMaxLength"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsReadRateMax int64 `json:"diskIopsReadRateMax"` + DiskIopsReadRateMaxLength int64 `json:"diskIopsReadRateMaxLength"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + DiskIopsWriteRateMax int64 `json:"diskIopsWriteRateMax"` + DiskIopsWriteRateMaxLength int64 `json:"diskIopsWriteRateMaxLength"` + Disksize int64 `json:"disksize"` + Disksizestrictness bool `json:"disksizestrictness"` + Displayoffering bool `json:"displayoffering"` + Displaytext string `json:"displaytext"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Encrypt bool `json:"encrypt"` + Hasannotations bool `json:"hasannotations"` + Hypervisorsnapshotreserve int `json:"hypervisorsnapshotreserve"` + Id string `json:"id"` + Iscustomized bool `json:"iscustomized"` + Iscustomizediops bool `json:"iscustomizediops"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Provisioningtype string `json:"provisioningtype"` + Storagetype string `json:"storagetype"` + Tags string `json:"tags"` + Vspherestoragepolicy string `json:"vspherestoragepolicy"` + Zone string `json:"zone"` + Zoneid string `json:"zoneid"` } diff --git a/cloudstack/HostService.go b/cloudstack/HostService.go index d96c5962..b29f87f6 100644 --- a/cloudstack/HostService.go +++ b/cloudstack/HostService.go @@ -340,6 +340,7 @@ type AddBaremetalHostResponse struct { Disconnected string `json:"disconnected"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` + Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Gpugroup []AddBaremetalHostResponseGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` @@ -777,6 +778,7 @@ type AddHostResponse struct { Disconnected string `json:"disconnected"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` + Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Gpugroup []AddHostResponseGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` @@ -1020,6 +1022,7 @@ type CancelHostMaintenanceResponse struct { Disconnected string `json:"disconnected"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` + Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Gpugroup []CancelHostMaintenanceResponseGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` @@ -2638,6 +2641,7 @@ type Host struct { Disconnected string `json:"disconnected"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` + Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Gpugroup []HostGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` @@ -3159,6 +3163,7 @@ type HostsMetric struct { Disconnected string `json:"disconnected"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` + Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Gpugroup []HostsMetricGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` @@ -3324,6 +3329,7 @@ type PrepareHostForMaintenanceResponse struct { Disconnected string `json:"disconnected"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` + Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Gpugroup []PrepareHostForMaintenanceResponseGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` @@ -3478,6 +3484,7 @@ type ReconnectHostResponse struct { Disconnected string `json:"disconnected"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` + Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Gpugroup []ReconnectHostResponseGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` @@ -3873,6 +3880,7 @@ type UpdateHostResponse struct { Disconnected string `json:"disconnected"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` + Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Gpugroup []UpdateHostResponseGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` diff --git a/cloudstack/ISOService.go b/cloudstack/ISOService.go index 3fb883a1..4f3a9703 100644 --- a/cloudstack/ISOService.go +++ b/cloudstack/ISOService.go @@ -169,6 +169,8 @@ func (s *ISOService) AttachIso(p *AttachIsoParams) (*AttachIsoResponse, error) { type AttachIsoResponse struct { Account string `json:"account"` Affinitygroup []AttachIsoResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -194,6 +196,7 @@ type AttachIsoResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -239,6 +242,11 @@ type AttachIsoResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -493,6 +501,10 @@ type CopyIsoResponse struct { Templatetag string `json:"templatetag"` Templatetype string `json:"templatetype"` Url string `json:"url"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdataparams string `json:"userdataparams"` + Userdatapolicy string `json:"userdatapolicy"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -714,6 +726,8 @@ func (s *ISOService) DetachIso(p *DetachIsoParams) (*DetachIsoResponse, error) { type DetachIsoResponse struct { Account string `json:"account"` Affinitygroup []DetachIsoResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -739,6 +753,7 @@ type DetachIsoResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -784,6 +799,11 @@ type DetachIsoResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -1658,6 +1678,10 @@ type Iso struct { Templatetag string `json:"templatetag"` Templatetype string `json:"templatetype"` Url string `json:"url"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdataparams string `json:"userdataparams"` + Userdatapolicy string `json:"userdatapolicy"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -2094,6 +2118,10 @@ type RegisterIsoResponse struct { Templatetag string `json:"templatetag"` Templatetype string `json:"templatetype"` Url string `json:"url"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdataparams string `json:"userdataparams"` + Userdatapolicy string `json:"userdatapolicy"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -2473,6 +2501,10 @@ type UpdateIsoResponse struct { Templatetag string `json:"templatetag"` Templatetype string `json:"templatetype"` Url string `json:"url"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdataparams string `json:"userdataparams"` + Userdatapolicy string `json:"userdatapolicy"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } diff --git a/cloudstack/InfrastructureUsageService.go b/cloudstack/InfrastructureUsageService.go index d8a29803..86edce92 100644 --- a/cloudstack/InfrastructureUsageService.go +++ b/cloudstack/InfrastructureUsageService.go @@ -357,10 +357,10 @@ type DbMetric struct { Hostname string `json:"hostname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Queries int `json:"queries"` + Queries int64 `json:"queries"` Replicas string `json:"replicas"` Tlsversions string `json:"tlsversions"` - Uptime int `json:"uptime"` + Uptime int64 `json:"uptime"` Version string `json:"version"` Versioncomment string `json:"versioncomment"` } diff --git a/cloudstack/InternalLBService.go b/cloudstack/InternalLBService.go index d65054df..b467c35f 100644 --- a/cloudstack/InternalLBService.go +++ b/cloudstack/InternalLBService.go @@ -891,6 +891,7 @@ type InternalLoadBalancerVM struct { Hasannotations bool `json:"hasannotations"` Healthcheckresults []InternalLoadBalancerVMHealthcheckresults `json:"healthcheckresults"` Healthchecksfailed bool `json:"healthchecksfailed"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -1030,6 +1031,7 @@ type StartInternalLoadBalancerVMResponse struct { Hasannotations bool `json:"hasannotations"` Healthcheckresults []StartInternalLoadBalancerVMResponseHealthcheckresults `json:"healthcheckresults"` Healthchecksfailed bool `json:"healthchecksfailed"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -1188,6 +1190,7 @@ type StopInternalLoadBalancerVMResponse struct { Hasannotations bool `json:"hasannotations"` Healthcheckresults []StopInternalLoadBalancerVMResponseHealthcheckresults `json:"healthcheckresults"` Healthchecksfailed bool `json:"healthchecksfailed"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` diff --git a/cloudstack/LDAPService.go b/cloudstack/LDAPService.go index 3b421796..f9669a58 100644 --- a/cloudstack/LDAPService.go +++ b/cloudstack/LDAPService.go @@ -1009,6 +1009,8 @@ type LdapCreateAccountResponseUser struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` Lastname string `json:"lastname"` diff --git a/cloudstack/NetworkOfferingService.go b/cloudstack/NetworkOfferingService.go index 932b11dd..e68754f6 100644 --- a/cloudstack/NetworkOfferingService.go +++ b/cloudstack/NetworkOfferingService.go @@ -78,6 +78,10 @@ func (p *CreateNetworkOfferingParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("enable", vv) } + if v, found := p.p["fortungsten"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("fortungsten", vv) + } if v, found := p.p["forvpc"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("forvpc", vv) @@ -254,6 +258,21 @@ func (p *CreateNetworkOfferingParams) GetEnable() (bool, bool) { return value, ok } +func (p *CreateNetworkOfferingParams) SetFortungsten(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["fortungsten"] = v +} + +func (p *CreateNetworkOfferingParams) GetFortungsten() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["fortungsten"].(bool) + return value, ok +} + func (p *CreateNetworkOfferingParams) SetForvpc(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -549,6 +568,7 @@ type CreateNetworkOfferingResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Egressdefaultpolicy bool `json:"egressdefaultpolicy"` + Fortungsten bool `json:"fortungsten"` Forvpc bool `json:"forvpc"` Guestiptype string `json:"guestiptype"` Hasannotations bool `json:"hasannotations"` @@ -1203,6 +1223,7 @@ type NetworkOffering struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Egressdefaultpolicy bool `json:"egressdefaultpolicy"` + Fortungsten bool `json:"fortungsten"` Forvpc bool `json:"forvpc"` Guestiptype string `json:"guestiptype"` Hasannotations bool `json:"hasannotations"` @@ -1499,6 +1520,7 @@ type UpdateNetworkOfferingResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Egressdefaultpolicy bool `json:"egressdefaultpolicy"` + Fortungsten bool `json:"fortungsten"` Forvpc bool `json:"forvpc"` Guestiptype string `json:"guestiptype"` Hasannotations bool `json:"hasannotations"` diff --git a/cloudstack/NetworkService.go b/cloudstack/NetworkService.go index ca8a005c..ef913bd4 100644 --- a/cloudstack/NetworkService.go +++ b/cloudstack/NetworkService.go @@ -33,7 +33,7 @@ type NetworkServiceIface interface { AddOpenDaylightController(p *AddOpenDaylightControllerParams) (*AddOpenDaylightControllerResponse, error) NewAddOpenDaylightControllerParams(password string, physicalnetworkid string, url string, username string) *AddOpenDaylightControllerParams CreateNetwork(p *CreateNetworkParams) (*CreateNetworkResponse, error) - NewCreateNetworkParams(displaytext string, name string, networkofferingid string, zoneid string) *CreateNetworkParams + NewCreateNetworkParams(name string, networkofferingid string, zoneid string) *CreateNetworkParams CreatePhysicalNetwork(p *CreatePhysicalNetworkParams) (*CreatePhysicalNetworkResponse, error) NewCreatePhysicalNetworkParams(name string, zoneid string) *CreatePhysicalNetworkParams CreateServiceInstance(p *CreateServiceInstanceParams) (*CreateServiceInstanceResponse, error) @@ -428,6 +428,12 @@ func (p *CreateNetworkParams) toURLValues() url.Values { if v, found := p.p["displaytext"]; found { u.Set("displaytext", v.(string)) } + if v, found := p.p["dns1"]; found { + u.Set("dns1", v.(string)) + } + if v, found := p.p["dns2"]; found { + u.Set("dns2", v.(string)) + } if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } @@ -450,6 +456,12 @@ func (p *CreateNetworkParams) toURLValues() url.Values { if v, found := p.p["ip6cidr"]; found { u.Set("ip6cidr", v.(string)) } + if v, found := p.p["ip6dns1"]; found { + u.Set("ip6dns1", v.(string)) + } + if v, found := p.p["ip6dns2"]; found { + u.Set("ip6dns2", v.(string)) + } if v, found := p.p["ip6gateway"]; found { u.Set("ip6gateway", v.(string)) } @@ -474,9 +486,17 @@ func (p *CreateNetworkParams) toURLValues() url.Values { if v, found := p.p["physicalnetworkid"]; found { u.Set("physicalnetworkid", v.(string)) } + if v, found := p.p["privatemtu"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("privatemtu", vv) + } if v, found := p.p["projectid"]; found { u.Set("projectid", v.(string)) } + if v, found := p.p["publicmtu"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("publicmtu", vv) + } if v, found := p.p["routerip"]; found { u.Set("routerip", v.(string)) } @@ -493,6 +513,9 @@ func (p *CreateNetworkParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("subdomainaccess", vv) } + if v, found := p.p["tungstenvirtualrouteruuid"]; found { + u.Set("tungstenvirtualrouteruuid", v.(string)) + } if v, found := p.p["vlan"]; found { u.Set("vlan", v.(string)) } @@ -610,6 +633,36 @@ func (p *CreateNetworkParams) GetDisplaytext() (string, bool) { return value, ok } +func (p *CreateNetworkParams) SetDns1(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["dns1"] = v +} + +func (p *CreateNetworkParams) GetDns1() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["dns1"].(string) + return value, ok +} + +func (p *CreateNetworkParams) SetDns2(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["dns2"] = v +} + +func (p *CreateNetworkParams) GetDns2() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["dns2"].(string) + return value, ok +} + func (p *CreateNetworkParams) SetDomainid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -715,6 +768,36 @@ func (p *CreateNetworkParams) GetIp6cidr() (string, bool) { return value, ok } +func (p *CreateNetworkParams) SetIp6dns1(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ip6dns1"] = v +} + +func (p *CreateNetworkParams) GetIp6dns1() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ip6dns1"].(string) + return value, ok +} + +func (p *CreateNetworkParams) SetIp6dns2(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ip6dns2"] = v +} + +func (p *CreateNetworkParams) GetIp6dns2() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ip6dns2"].(string) + return value, ok +} + func (p *CreateNetworkParams) SetIp6gateway(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -835,6 +918,21 @@ func (p *CreateNetworkParams) GetPhysicalnetworkid() (string, bool) { return value, ok } +func (p *CreateNetworkParams) SetPrivatemtu(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["privatemtu"] = v +} + +func (p *CreateNetworkParams) GetPrivatemtu() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["privatemtu"].(int) + return value, ok +} + func (p *CreateNetworkParams) SetProjectid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -850,6 +948,21 @@ func (p *CreateNetworkParams) GetProjectid() (string, bool) { return value, ok } +func (p *CreateNetworkParams) SetPublicmtu(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["publicmtu"] = v +} + +func (p *CreateNetworkParams) GetPublicmtu() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["publicmtu"].(int) + return value, ok +} + func (p *CreateNetworkParams) SetRouterip(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -925,6 +1038,21 @@ func (p *CreateNetworkParams) GetSubdomainaccess() (bool, bool) { return value, ok } +func (p *CreateNetworkParams) SetTungstenvirtualrouteruuid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["tungstenvirtualrouteruuid"] = v +} + +func (p *CreateNetworkParams) GetTungstenvirtualrouteruuid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["tungstenvirtualrouteruuid"].(string) + return value, ok +} + func (p *CreateNetworkParams) SetVlan(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -972,10 +1100,9 @@ func (p *CreateNetworkParams) GetZoneid() (string, bool) { // You should always use this function to get a new CreateNetworkParams instance, // as then you are sure you have configured all required params -func (s *NetworkService) NewCreateNetworkParams(displaytext string, name string, networkofferingid string, zoneid string) *CreateNetworkParams { +func (s *NetworkService) NewCreateNetworkParams(name string, networkofferingid string, zoneid string) *CreateNetworkParams { p := &CreateNetworkParams{} p.p = make(map[string]interface{}) - p.p["displaytext"] = displaytext p.p["name"] = name p.p["networkofferingid"] = networkofferingid p.p["zoneid"] = zoneid @@ -1028,6 +1155,8 @@ type CreateNetworkResponse struct { Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` Ip6cidr string `json:"ip6cidr"` + Ip6dns1 string `json:"ip6dns1"` + Ip6dns2 string `json:"ip6dns2"` Ip6gateway string `json:"ip6gateway"` Ip6routes []interface{} `json:"ip6routes"` Ip6routing string `json:"ip6routing"` @@ -1046,8 +1175,10 @@ type CreateNetworkResponse struct { Networkofferingid string `json:"networkofferingid"` Networkofferingname string `json:"networkofferingname"` Physicalnetworkid string `json:"physicalnetworkid"` + Privatemtu int `json:"privatemtu"` Project string `json:"project"` Projectid string `json:"projectid"` + Publicmtu int `json:"publicmtu"` Receivedbytes int64 `json:"receivedbytes"` Redundantrouter bool `json:"redundantrouter"` Related string `json:"related"` @@ -1059,8 +1190,10 @@ type CreateNetworkResponse struct { State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` + Supportsvmautoscaling bool `json:"supportsvmautoscaling"` Tags []Tags `json:"tags"` Traffictype string `json:"traffictype"` + Tungstenvirtualrouteruuid string `json:"tungstenvirtualrouteruuid"` Type string `json:"type"` Vlan string `json:"vlan"` Vpcid string `json:"vpcid"` @@ -2453,6 +2586,8 @@ type NetscalerLoadBalancerNetwork struct { Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` Ip6cidr string `json:"ip6cidr"` + Ip6dns1 string `json:"ip6dns1"` + Ip6dns2 string `json:"ip6dns2"` Ip6gateway string `json:"ip6gateway"` Ip6routes []interface{} `json:"ip6routes"` Ip6routing string `json:"ip6routing"` @@ -2471,8 +2606,10 @@ type NetscalerLoadBalancerNetwork struct { Networkofferingid string `json:"networkofferingid"` Networkofferingname string `json:"networkofferingname"` Physicalnetworkid string `json:"physicalnetworkid"` + Privatemtu int `json:"privatemtu"` Project string `json:"project"` Projectid string `json:"projectid"` + Publicmtu int `json:"publicmtu"` Receivedbytes int64 `json:"receivedbytes"` Redundantrouter bool `json:"redundantrouter"` Related string `json:"related"` @@ -2484,8 +2621,10 @@ type NetscalerLoadBalancerNetwork struct { State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` + Supportsvmautoscaling bool `json:"supportsvmautoscaling"` Tags []Tags `json:"tags"` Traffictype string `json:"traffictype"` + Tungstenvirtualrouteruuid string `json:"tungstenvirtualrouteruuid"` Type string `json:"type"` Vlan string `json:"vlan"` Vpcid string `json:"vpcid"` @@ -3487,6 +3626,8 @@ type Network struct { Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` Ip6cidr string `json:"ip6cidr"` + Ip6dns1 string `json:"ip6dns1"` + Ip6dns2 string `json:"ip6dns2"` Ip6gateway string `json:"ip6gateway"` Ip6routes []interface{} `json:"ip6routes"` Ip6routing string `json:"ip6routing"` @@ -3505,8 +3646,10 @@ type Network struct { Networkofferingid string `json:"networkofferingid"` Networkofferingname string `json:"networkofferingname"` Physicalnetworkid string `json:"physicalnetworkid"` + Privatemtu int `json:"privatemtu"` Project string `json:"project"` Projectid string `json:"projectid"` + Publicmtu int `json:"publicmtu"` Receivedbytes int64 `json:"receivedbytes"` Redundantrouter bool `json:"redundantrouter"` Related string `json:"related"` @@ -3518,8 +3661,10 @@ type Network struct { State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` + Supportsvmautoscaling bool `json:"supportsvmautoscaling"` Tags []Tags `json:"tags"` Traffictype string `json:"traffictype"` + Tungstenvirtualrouteruuid string `json:"tungstenvirtualrouteruuid"` Type string `json:"type"` Vlan string `json:"vlan"` Vpcid string `json:"vpcid"` @@ -3730,6 +3875,8 @@ type NiciraNvpDeviceNetwork struct { Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` Ip6cidr string `json:"ip6cidr"` + Ip6dns1 string `json:"ip6dns1"` + Ip6dns2 string `json:"ip6dns2"` Ip6gateway string `json:"ip6gateway"` Ip6routes []interface{} `json:"ip6routes"` Ip6routing string `json:"ip6routing"` @@ -3748,8 +3895,10 @@ type NiciraNvpDeviceNetwork struct { Networkofferingid string `json:"networkofferingid"` Networkofferingname string `json:"networkofferingname"` Physicalnetworkid string `json:"physicalnetworkid"` + Privatemtu int `json:"privatemtu"` Project string `json:"project"` Projectid string `json:"projectid"` + Publicmtu int `json:"publicmtu"` Receivedbytes int64 `json:"receivedbytes"` Redundantrouter bool `json:"redundantrouter"` Related string `json:"related"` @@ -3761,8 +3910,10 @@ type NiciraNvpDeviceNetwork struct { State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` + Supportsvmautoscaling bool `json:"supportsvmautoscaling"` Tags []Tags `json:"tags"` Traffictype string `json:"traffictype"` + Tungstenvirtualrouteruuid string `json:"tungstenvirtualrouteruuid"` Type string `json:"type"` Vlan string `json:"vlan"` Vpcid string `json:"vpcid"` @@ -4092,6 +4243,8 @@ type PaloAltoFirewallNetwork struct { Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` Ip6cidr string `json:"ip6cidr"` + Ip6dns1 string `json:"ip6dns1"` + Ip6dns2 string `json:"ip6dns2"` Ip6gateway string `json:"ip6gateway"` Ip6routes []interface{} `json:"ip6routes"` Ip6routing string `json:"ip6routing"` @@ -4110,8 +4263,10 @@ type PaloAltoFirewallNetwork struct { Networkofferingid string `json:"networkofferingid"` Networkofferingname string `json:"networkofferingname"` Physicalnetworkid string `json:"physicalnetworkid"` + Privatemtu int `json:"privatemtu"` Project string `json:"project"` Projectid string `json:"projectid"` + Publicmtu int `json:"publicmtu"` Receivedbytes int64 `json:"receivedbytes"` Redundantrouter bool `json:"redundantrouter"` Related string `json:"related"` @@ -4123,8 +4278,10 @@ type PaloAltoFirewallNetwork struct { State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` + Supportsvmautoscaling bool `json:"supportsvmautoscaling"` Tags []Tags `json:"tags"` Traffictype string `json:"traffictype"` + Tungstenvirtualrouteruuid string `json:"tungstenvirtualrouteruuid"` Type string `json:"type"` Vlan string `json:"vlan"` Vpcid string `json:"vpcid"` @@ -5002,6 +5159,12 @@ func (p *UpdateNetworkParams) toURLValues() url.Values { if v, found := p.p["displaytext"]; found { u.Set("displaytext", v.(string)) } + if v, found := p.p["dns1"]; found { + u.Set("dns1", v.(string)) + } + if v, found := p.p["dns2"]; found { + u.Set("dns2", v.(string)) + } if v, found := p.p["forced"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("forced", vv) @@ -5016,6 +5179,12 @@ func (p *UpdateNetworkParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["ip6dns1"]; found { + u.Set("ip6dns1", v.(string)) + } + if v, found := p.p["ip6dns2"]; found { + u.Set("ip6dns2", v.(string)) + } if v, found := p.p["name"]; found { u.Set("name", v.(string)) } @@ -5025,6 +5194,14 @@ func (p *UpdateNetworkParams) toURLValues() url.Values { if v, found := p.p["networkofferingid"]; found { u.Set("networkofferingid", v.(string)) } + if v, found := p.p["privatemtu"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("privatemtu", vv) + } + if v, found := p.p["publicmtu"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("publicmtu", vv) + } if v, found := p.p["updateinsequence"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("updateinsequence", vv) @@ -5092,6 +5269,36 @@ func (p *UpdateNetworkParams) GetDisplaytext() (string, bool) { return value, ok } +func (p *UpdateNetworkParams) SetDns1(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["dns1"] = v +} + +func (p *UpdateNetworkParams) GetDns1() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["dns1"].(string) + return value, ok +} + +func (p *UpdateNetworkParams) SetDns2(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["dns2"] = v +} + +func (p *UpdateNetworkParams) GetDns2() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["dns2"].(string) + return value, ok +} + func (p *UpdateNetworkParams) SetForced(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -5152,6 +5359,36 @@ func (p *UpdateNetworkParams) GetId() (string, bool) { return value, ok } +func (p *UpdateNetworkParams) SetIp6dns1(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ip6dns1"] = v +} + +func (p *UpdateNetworkParams) GetIp6dns1() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ip6dns1"].(string) + return value, ok +} + +func (p *UpdateNetworkParams) SetIp6dns2(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ip6dns2"] = v +} + +func (p *UpdateNetworkParams) GetIp6dns2() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ip6dns2"].(string) + return value, ok +} + func (p *UpdateNetworkParams) SetName(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -5197,6 +5434,36 @@ func (p *UpdateNetworkParams) GetNetworkofferingid() (string, bool) { return value, ok } +func (p *UpdateNetworkParams) SetPrivatemtu(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["privatemtu"] = v +} + +func (p *UpdateNetworkParams) GetPrivatemtu() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["privatemtu"].(int) + return value, ok +} + +func (p *UpdateNetworkParams) SetPublicmtu(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["publicmtu"] = v +} + +func (p *UpdateNetworkParams) GetPublicmtu() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["publicmtu"].(int) + return value, ok +} + func (p *UpdateNetworkParams) SetUpdateinsequence(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -5283,6 +5550,8 @@ type UpdateNetworkResponse struct { Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` Ip6cidr string `json:"ip6cidr"` + Ip6dns1 string `json:"ip6dns1"` + Ip6dns2 string `json:"ip6dns2"` Ip6gateway string `json:"ip6gateway"` Ip6routes []interface{} `json:"ip6routes"` Ip6routing string `json:"ip6routing"` @@ -5301,8 +5570,10 @@ type UpdateNetworkResponse struct { Networkofferingid string `json:"networkofferingid"` Networkofferingname string `json:"networkofferingname"` Physicalnetworkid string `json:"physicalnetworkid"` + Privatemtu int `json:"privatemtu"` Project string `json:"project"` Projectid string `json:"projectid"` + Publicmtu int `json:"publicmtu"` Receivedbytes int64 `json:"receivedbytes"` Redundantrouter bool `json:"redundantrouter"` Related string `json:"related"` @@ -5314,8 +5585,10 @@ type UpdateNetworkResponse struct { State string `json:"state"` Strechedl2subnet bool `json:"strechedl2subnet"` Subdomainaccess bool `json:"subdomainaccess"` + Supportsvmautoscaling bool `json:"supportsvmautoscaling"` Tags []Tags `json:"tags"` Traffictype string `json:"traffictype"` + Tungstenvirtualrouteruuid string `json:"tungstenvirtualrouteruuid"` Type string `json:"type"` Vlan string `json:"vlan"` Vpcid string `json:"vpcid"` diff --git a/cloudstack/NetworkService_mock.go b/cloudstack/NetworkService_mock.go index 82f872ec..1ff2df8c 100644 --- a/cloudstack/NetworkService_mock.go +++ b/cloudstack/NetworkService_mock.go @@ -773,17 +773,17 @@ func (mr *MockNetworkServiceIfaceMockRecorder) NewCreateGuestNetworkIpv6PrefixPa } // NewCreateNetworkParams mocks base method. -func (m *MockNetworkServiceIface) NewCreateNetworkParams(displaytext, name, networkofferingid, zoneid string) *CreateNetworkParams { +func (m *MockNetworkServiceIface) NewCreateNetworkParams(name, networkofferingid, zoneid string) *CreateNetworkParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewCreateNetworkParams", displaytext, name, networkofferingid, zoneid) + ret := m.ctrl.Call(m, "NewCreateNetworkParams", name, networkofferingid, zoneid) ret0, _ := ret[0].(*CreateNetworkParams) return ret0 } // NewCreateNetworkParams indicates an expected call of NewCreateNetworkParams. -func (mr *MockNetworkServiceIfaceMockRecorder) NewCreateNetworkParams(displaytext, name, networkofferingid, zoneid interface{}) *gomock.Call { +func (mr *MockNetworkServiceIfaceMockRecorder) NewCreateNetworkParams(name, networkofferingid, zoneid interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateNetworkParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewCreateNetworkParams), displaytext, name, networkofferingid, zoneid) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateNetworkParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewCreateNetworkParams), name, networkofferingid, zoneid) } // NewCreateNetworkPermissionsParams mocks base method. diff --git a/cloudstack/NicService.go b/cloudstack/NicService.go index 13ae6c8f..ed048c66 100644 --- a/cloudstack/NicService.go +++ b/cloudstack/NicService.go @@ -331,6 +331,7 @@ type Nic struct { JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Macaddress string `json:"macaddress"` + Mtu int `json:"mtu"` Netmask string `json:"netmask"` Networkid string `json:"networkid"` Networkname string `json:"networkname"` @@ -519,6 +520,8 @@ func (s *NicService) UpdateVmNicIp(p *UpdateVmNicIpParams) (*UpdateVmNicIpRespon type UpdateVmNicIpResponse struct { Account string `json:"account"` Affinitygroup []UpdateVmNicIpResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -544,6 +547,7 @@ type UpdateVmNicIpResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -589,6 +593,11 @@ type UpdateVmNicIpResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` diff --git a/cloudstack/PodService.go b/cloudstack/PodService.go index 723de17f..c4e369a7 100644 --- a/cloudstack/PodService.go +++ b/cloudstack/PodService.go @@ -29,7 +29,7 @@ import ( type PodServiceIface interface { CreatePod(p *CreatePodParams) (*CreatePodResponse, error) - NewCreatePodParams(gateway string, name string, netmask string, startip string, zoneid string) *CreatePodParams + NewCreatePodParams(name string, zoneid string) *CreatePodParams DedicatePod(p *DedicatePodParams) (*DedicatePodResponse, error) NewDedicatePodParams(domainid string, podid string) *DedicatePodParams DeletePod(p *DeletePodParams) (*DeletePodResponse, error) @@ -187,13 +187,10 @@ func (p *CreatePodParams) GetZoneid() (string, bool) { // You should always use this function to get a new CreatePodParams instance, // as then you are sure you have configured all required params -func (s *PodService) NewCreatePodParams(gateway string, name string, netmask string, startip string, zoneid string) *CreatePodParams { +func (s *PodService) NewCreatePodParams(name string, zoneid string) *CreatePodParams { p := &CreatePodParams{} p.p = make(map[string]interface{}) - p.p["gateway"] = gateway p.p["name"] = name - p.p["netmask"] = netmask - p.p["startip"] = startip p.p["zoneid"] = zoneid return p } diff --git a/cloudstack/PodService_mock.go b/cloudstack/PodService_mock.go index b879327d..8d4cd3b9 100644 --- a/cloudstack/PodService_mock.go +++ b/cloudstack/PodService_mock.go @@ -191,17 +191,17 @@ func (mr *MockPodServiceIfaceMockRecorder) ListPods(p interface{}) *gomock.Call } // NewCreatePodParams mocks base method. -func (m *MockPodServiceIface) NewCreatePodParams(gateway, name, netmask, startip, zoneid string) *CreatePodParams { +func (m *MockPodServiceIface) NewCreatePodParams(name, zoneid string) *CreatePodParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewCreatePodParams", gateway, name, netmask, startip, zoneid) + ret := m.ctrl.Call(m, "NewCreatePodParams", name, zoneid) ret0, _ := ret[0].(*CreatePodParams) return ret0 } // NewCreatePodParams indicates an expected call of NewCreatePodParams. -func (mr *MockPodServiceIfaceMockRecorder) NewCreatePodParams(gateway, name, netmask, startip, zoneid interface{}) *gomock.Call { +func (mr *MockPodServiceIfaceMockRecorder) NewCreatePodParams(name, zoneid interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreatePodParams", reflect.TypeOf((*MockPodServiceIface)(nil).NewCreatePodParams), gateway, name, netmask, startip, zoneid) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreatePodParams", reflect.TypeOf((*MockPodServiceIface)(nil).NewCreatePodParams), name, zoneid) } // NewDedicatePodParams mocks base method. diff --git a/cloudstack/RouterService.go b/cloudstack/RouterService.go index 0a7bad71..a460d2e5 100644 --- a/cloudstack/RouterService.go +++ b/cloudstack/RouterService.go @@ -141,6 +141,7 @@ type ChangeServiceForRouterResponse struct { Hasannotations bool `json:"hasannotations"` Healthcheckresults []ChangeServiceForRouterResponseHealthcheckresults `json:"healthcheckresults"` Healthchecksfailed bool `json:"healthchecksfailed"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -492,6 +493,7 @@ type DestroyRouterResponse struct { Hasannotations bool `json:"hasannotations"` Healthcheckresults []DestroyRouterResponseHealthcheckresults `json:"healthcheckresults"` Healthchecksfailed bool `json:"healthchecksfailed"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -1065,6 +1067,7 @@ type Router struct { Hasannotations bool `json:"hasannotations"` Healthcheckresults []RouterHealthcheckresults `json:"healthcheckresults"` Healthchecksfailed bool `json:"healthchecksfailed"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -1420,6 +1423,7 @@ type RebootRouterResponse struct { Hasannotations bool `json:"hasannotations"` Healthcheckresults []RebootRouterResponseHealthcheckresults `json:"healthcheckresults"` Healthchecksfailed bool `json:"healthchecksfailed"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -1559,6 +1563,7 @@ type StartRouterResponse struct { Hasannotations bool `json:"hasannotations"` Healthcheckresults []StartRouterResponseHealthcheckresults `json:"healthcheckresults"` Healthchecksfailed bool `json:"healthchecksfailed"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -1717,6 +1722,7 @@ type StopRouterResponse struct { Hasannotations bool `json:"hasannotations"` Healthcheckresults []StopRouterResponseHealthcheckresults `json:"healthcheckresults"` Healthchecksfailed bool `json:"healthchecksfailed"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` diff --git a/cloudstack/SSHService.go b/cloudstack/SSHService.go index 45274cd6..2abe0bff 100644 --- a/cloudstack/SSHService.go +++ b/cloudstack/SSHService.go @@ -166,6 +166,8 @@ type CreateSSHKeyPairResponse struct { Jobstatus int `json:"jobstatus"` Name string `json:"name"` Privatekey string `json:"privatekey"` + Project string `json:"project"` + Projectid string `json:"projectid"` } type DeleteSSHKeyPairParams struct { @@ -645,6 +647,8 @@ type SSHKeyPair struct { JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` } type RegisterSSHKeyPairParams struct { @@ -788,6 +792,8 @@ type RegisterSSHKeyPairResponse struct { JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` } type ResetSSHKeyForVirtualMachineParams struct { @@ -958,6 +964,8 @@ func (s *SSHService) ResetSSHKeyForVirtualMachine(p *ResetSSHKeyForVirtualMachin type ResetSSHKeyForVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []ResetSSHKeyForVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -983,6 +991,7 @@ type ResetSSHKeyForVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -1028,6 +1037,11 @@ type ResetSSHKeyForVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` diff --git a/cloudstack/ServiceOfferingService.go b/cloudstack/ServiceOfferingService.go index 5dc3aa66..baf19d71 100644 --- a/cloudstack/ServiceOfferingService.go +++ b/cloudstack/ServiceOfferingService.go @@ -114,6 +114,10 @@ func (p *CreateServiceOfferingParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("dynamicscalingenabled", vv) } + if v, found := p.p["encryptroot"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("encryptroot", vv) + } if v, found := p.p["hosttags"]; found { u.Set("hosttags", v.(string)) } @@ -484,6 +488,21 @@ func (p *CreateServiceOfferingParams) GetDynamicscalingenabled() (bool, bool) { return value, ok } +func (p *CreateServiceOfferingParams) SetEncryptroot(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["encryptroot"] = v +} + +func (p *CreateServiceOfferingParams) GetEncryptroot() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["encryptroot"].(bool) + return value, ok +} + func (p *CreateServiceOfferingParams) SetHosttags(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -975,6 +994,7 @@ type CreateServiceOfferingResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Dynamicscalingenabled bool `json:"dynamicscalingenabled"` + Encryptroot bool `json:"encryptroot"` Hasannotations bool `json:"hasannotations"` Hosttags string `json:"hosttags"` Hypervisorsnapshotreserve int `json:"hypervisorsnapshotreserve"` @@ -1111,6 +1131,10 @@ func (p *ListServiceOfferingsParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["encryptroot"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("encryptroot", vv) + } if v, found := p.p["id"]; found { u.Set("id", v.(string)) } @@ -1201,6 +1225,21 @@ func (p *ListServiceOfferingsParams) GetDomainid() (string, bool) { return value, ok } +func (p *ListServiceOfferingsParams) SetEncryptroot(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["encryptroot"] = v +} + +func (p *ListServiceOfferingsParams) GetEncryptroot() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["encryptroot"].(bool) + return value, ok +} + func (p *ListServiceOfferingsParams) SetId(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1519,6 +1558,7 @@ type ServiceOffering struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Dynamicscalingenabled bool `json:"dynamicscalingenabled"` + Encryptroot bool `json:"encryptroot"` Hasannotations bool `json:"hasannotations"` Hosttags string `json:"hosttags"` Hypervisorsnapshotreserve int `json:"hypervisorsnapshotreserve"` @@ -1759,6 +1799,7 @@ type UpdateServiceOfferingResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Dynamicscalingenabled bool `json:"dynamicscalingenabled"` + Encryptroot bool `json:"encryptroot"` Hasannotations bool `json:"hasannotations"` Hosttags string `json:"hosttags"` Hypervisorsnapshotreserve int `json:"hypervisorsnapshotreserve"` diff --git a/cloudstack/SnapshotService.go b/cloudstack/SnapshotService.go index d84aa57c..15bb2ce7 100644 --- a/cloudstack/SnapshotService.go +++ b/cloudstack/SnapshotService.go @@ -2200,6 +2200,8 @@ func (s *SnapshotService) RevertToVMSnapshot(p *RevertToVMSnapshotParams) (*Reve type RevertToVMSnapshotResponse struct { Account string `json:"account"` Affinitygroup []RevertToVMSnapshotResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -2225,6 +2227,7 @@ type RevertToVMSnapshotResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -2270,6 +2273,11 @@ type RevertToVMSnapshotResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` diff --git a/cloudstack/SystemVMService.go b/cloudstack/SystemVMService.go index 36e418eb..40579301 100644 --- a/cloudstack/SystemVMService.go +++ b/cloudstack/SystemVMService.go @@ -155,6 +155,7 @@ type ChangeServiceForSystemVmResponse struct { Gateway string `json:"gateway"` Guestvlan string `json:"guestvlan"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -224,7 +225,7 @@ func (s *SystemVMService) NewDestroySystemVmParams(id string) *DestroySystemVmPa return p } -// Destroyes a system virtual machine. +// Destroys a system virtual machine. func (s *SystemVMService) DestroySystemVm(p *DestroySystemVmParams) (*DestroySystemVmResponse, error) { resp, err := s.cs.newRequest("destroySystemVm", p.toURLValues()) if err != nil { @@ -269,6 +270,7 @@ type DestroySystemVmResponse struct { Gateway string `json:"gateway"` Guestvlan string `json:"guestvlan"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -632,6 +634,7 @@ type SystemVm struct { Gateway string `json:"gateway"` Guestvlan string `json:"guestvlan"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -801,6 +804,7 @@ type MigrateSystemVmResponse struct { Gateway string `json:"gateway"` Guestvlan string `json:"guestvlan"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -934,6 +938,7 @@ type RebootSystemVmResponse struct { Gateway string `json:"gateway"` Guestvlan string `json:"guestvlan"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -1088,6 +1093,7 @@ type ScaleSystemVmResponse struct { Gateway string `json:"gateway"` Guestvlan string `json:"guestvlan"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -1202,6 +1208,7 @@ type StartSystemVmResponse struct { Gateway string `json:"gateway"` Guestvlan string `json:"guestvlan"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -1335,6 +1342,7 @@ type StopSystemVmResponse struct { Gateway string `json:"gateway"` Guestvlan string `json:"guestvlan"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` diff --git a/cloudstack/TemplateService.go b/cloudstack/TemplateService.go index 0e76a502..a65ed585 100644 --- a/cloudstack/TemplateService.go +++ b/cloudstack/TemplateService.go @@ -241,6 +241,10 @@ type CopyTemplateResponse struct { Templatetag string `json:"templatetag"` Templatetype string `json:"templatetype"` Url string `json:"url"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdataparams string `json:"userdataparams"` + Userdatapolicy string `json:"userdatapolicy"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -695,6 +699,10 @@ type CreateTemplateResponse struct { Templatetag string `json:"templatetag"` Templatetype string `json:"templatetype"` Url string `json:"url"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdataparams string `json:"userdataparams"` + Userdatapolicy string `json:"userdatapolicy"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -2100,6 +2108,10 @@ type Template struct { Templatetag string `json:"templatetag"` Templatetype string `json:"templatetype"` Url string `json:"url"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdataparams string `json:"userdataparams"` + Userdatapolicy string `json:"userdatapolicy"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -2271,6 +2283,10 @@ type PrepareTemplateResponse struct { Templatetag string `json:"templatetag"` Templatetype string `json:"templatetype"` Url string `json:"url"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdataparams string `json:"userdataparams"` + Userdatapolicy string `json:"userdatapolicy"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -2861,6 +2877,10 @@ type RegisterTemplate struct { Templatetag string `json:"templatetag"` Templatetype string `json:"templatetype"` Url string `json:"url"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdataparams string `json:"userdataparams"` + Userdatapolicy string `json:"userdatapolicy"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -3258,6 +3278,10 @@ type UpdateTemplateResponse struct { Templatetag string `json:"templatetag"` Templatetype string `json:"templatetype"` Url string `json:"url"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdataparams string `json:"userdataparams"` + Userdatapolicy string `json:"userdatapolicy"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -3441,7 +3465,7 @@ func (s *TemplateService) NewUpdateTemplatePermissionsParams(id string) *UpdateT return p } -// Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A priviledged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them. +// Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them. func (s *TemplateService) UpdateTemplatePermissions(p *UpdateTemplatePermissionsParams) (*UpdateTemplatePermissionsResponse, error) { resp, err := s.cs.newRequest("updateTemplatePermissions", p.toURLValues()) if err != nil { diff --git a/cloudstack/UserService.go b/cloudstack/UserService.go index 246b33bd..d622f392 100644 --- a/cloudstack/UserService.go +++ b/cloudstack/UserService.go @@ -272,6 +272,8 @@ type CreateUserResponse struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` JobID string `json:"jobid"` @@ -461,6 +463,8 @@ type DisableUserResponse struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` JobID string `json:"jobid"` @@ -546,6 +550,8 @@ type EnableUserResponse struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` JobID string `json:"jobid"` @@ -627,6 +633,8 @@ type GetUserResponse struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` JobID string `json:"jobid"` @@ -1079,6 +1087,8 @@ type User struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` JobID string `json:"jobid"` @@ -1164,6 +1174,8 @@ type LockUserResponse struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` JobID string `json:"jobid"` @@ -1268,6 +1280,10 @@ func (p *UpdateUserParams) toURLValues() url.Values { if v, found := p.p["lastname"]; found { u.Set("lastname", v.(string)) } + if v, found := p.p["mandate2fa"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("mandate2fa", vv) + } if v, found := p.p["password"]; found { u.Set("password", v.(string)) } @@ -1361,6 +1377,21 @@ func (p *UpdateUserParams) GetLastname() (string, bool) { return value, ok } +func (p *UpdateUserParams) SetMandate2fa(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["mandate2fa"] = v +} + +func (p *UpdateUserParams) GetMandate2fa() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["mandate2fa"].(bool) + return value, ok +} + func (p *UpdateUserParams) SetPassword(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1472,6 +1503,8 @@ type UpdateUserResponse struct { Firstname string `json:"firstname"` Icon interface{} `json:"icon"` Id string `json:"id"` + Is2faenabled bool `json:"is2faenabled"` + Is2famandated bool `json:"is2famandated"` Iscallerchilddomain bool `json:"iscallerchilddomain"` Isdefault bool `json:"isdefault"` JobID string `json:"jobid"` diff --git a/cloudstack/VPCService.go b/cloudstack/VPCService.go index 1425d740..4721a43d 100644 --- a/cloudstack/VPCService.go +++ b/cloudstack/VPCService.go @@ -481,6 +481,12 @@ func (p *CreateVPCParams) toURLValues() url.Values { if v, found := p.p["displaytext"]; found { u.Set("displaytext", v.(string)) } + if v, found := p.p["dns1"]; found { + u.Set("dns1", v.(string)) + } + if v, found := p.p["dns2"]; found { + u.Set("dns2", v.(string)) + } if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } @@ -488,6 +494,12 @@ func (p *CreateVPCParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("fordisplay", vv) } + if v, found := p.p["ip6dns1"]; found { + u.Set("ip6dns1", v.(string)) + } + if v, found := p.p["ip6dns2"]; found { + u.Set("ip6dns2", v.(string)) + } if v, found := p.p["name"]; found { u.Set("name", v.(string)) } @@ -497,6 +509,10 @@ func (p *CreateVPCParams) toURLValues() url.Values { if v, found := p.p["projectid"]; found { u.Set("projectid", v.(string)) } + if v, found := p.p["publicmtu"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("publicmtu", vv) + } if v, found := p.p["start"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("start", vv) @@ -555,6 +571,36 @@ func (p *CreateVPCParams) GetDisplaytext() (string, bool) { return value, ok } +func (p *CreateVPCParams) SetDns1(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["dns1"] = v +} + +func (p *CreateVPCParams) GetDns1() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["dns1"].(string) + return value, ok +} + +func (p *CreateVPCParams) SetDns2(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["dns2"] = v +} + +func (p *CreateVPCParams) GetDns2() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["dns2"].(string) + return value, ok +} + func (p *CreateVPCParams) SetDomainid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -585,6 +631,36 @@ func (p *CreateVPCParams) GetFordisplay() (bool, bool) { return value, ok } +func (p *CreateVPCParams) SetIp6dns1(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ip6dns1"] = v +} + +func (p *CreateVPCParams) GetIp6dns1() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ip6dns1"].(string) + return value, ok +} + +func (p *CreateVPCParams) SetIp6dns2(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ip6dns2"] = v +} + +func (p *CreateVPCParams) GetIp6dns2() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ip6dns2"].(string) + return value, ok +} + func (p *CreateVPCParams) SetName(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -630,6 +706,21 @@ func (p *CreateVPCParams) GetProjectid() (string, bool) { return value, ok } +func (p *CreateVPCParams) SetPublicmtu(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["publicmtu"] = v +} + +func (p *CreateVPCParams) GetPublicmtu() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["publicmtu"].(int) + return value, ok +} + func (p *CreateVPCParams) SetStart(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -729,12 +820,16 @@ type CreateVPCResponse struct { Created string `json:"created"` Displaytext string `json:"displaytext"` Distributedvpcrouter bool `json:"distributedvpcrouter"` + Dns1 string `json:"dns1"` + Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` Fordisplay bool `json:"fordisplay"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Ip6dns1 string `json:"ip6dns1"` + Ip6dns2 string `json:"ip6dns2"` Ip6routes []interface{} `json:"ip6routes"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` @@ -743,6 +838,7 @@ type CreateVPCResponse struct { Networkdomain string `json:"networkdomain"` Project string `json:"project"` Projectid string `json:"projectid"` + Publicmtu int `json:"publicmtu"` Redundantvpcrouter bool `json:"redundantvpcrouter"` Regionlevelvpc bool `json:"regionlevelvpc"` Restartrequired bool `json:"restartrequired"` @@ -2053,6 +2149,9 @@ func (p *ListVPCOfferingsParams) toURLValues() url.Values { if v, found := p.p["displaytext"]; found { u.Set("displaytext", v.(string)) } + if v, found := p.p["domainid"]; found { + u.Set("domainid", v.(string)) + } if v, found := p.p["id"]; found { u.Set("id", v.(string)) } @@ -2102,6 +2201,21 @@ func (p *ListVPCOfferingsParams) GetDisplaytext() (string, bool) { return value, ok } +func (p *ListVPCOfferingsParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *ListVPCOfferingsParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + func (p *ListVPCOfferingsParams) SetId(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2890,12 +3004,16 @@ type VPC struct { Created string `json:"created"` Displaytext string `json:"displaytext"` Distributedvpcrouter bool `json:"distributedvpcrouter"` + Dns1 string `json:"dns1"` + Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` Fordisplay bool `json:"fordisplay"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Ip6dns1 string `json:"ip6dns1"` + Ip6dns2 string `json:"ip6dns2"` Ip6routes []interface{} `json:"ip6routes"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` @@ -2904,6 +3022,7 @@ type VPC struct { Networkdomain string `json:"networkdomain"` Project string `json:"project"` Projectid string `json:"projectid"` + Publicmtu int `json:"publicmtu"` Redundantvpcrouter bool `json:"redundantvpcrouter"` Regionlevelvpc bool `json:"regionlevelvpc"` Restartrequired bool `json:"restartrequired"` @@ -3096,6 +3215,10 @@ func (p *UpdateVPCParams) toURLValues() url.Values { if v, found := p.p["name"]; found { u.Set("name", v.(string)) } + if v, found := p.p["publicmtu"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("publicmtu", vv) + } return u } @@ -3174,6 +3297,21 @@ func (p *UpdateVPCParams) GetName() (string, bool) { return value, ok } +func (p *UpdateVPCParams) SetPublicmtu(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["publicmtu"] = v +} + +func (p *UpdateVPCParams) GetPublicmtu() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["publicmtu"].(int) + return value, ok +} + // You should always use this function to get a new UpdateVPCParams instance, // as then you are sure you have configured all required params func (s *VPCService) NewUpdateVPCParams(id string) *UpdateVPCParams { @@ -3224,12 +3362,16 @@ type UpdateVPCResponse struct { Created string `json:"created"` Displaytext string `json:"displaytext"` Distributedvpcrouter bool `json:"distributedvpcrouter"` + Dns1 string `json:"dns1"` + Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` Fordisplay bool `json:"fordisplay"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Ip6dns1 string `json:"ip6dns1"` + Ip6dns2 string `json:"ip6dns2"` Ip6routes []interface{} `json:"ip6routes"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` @@ -3238,6 +3380,7 @@ type UpdateVPCResponse struct { Networkdomain string `json:"networkdomain"` Project string `json:"project"` Projectid string `json:"projectid"` + Publicmtu int `json:"publicmtu"` Redundantvpcrouter bool `json:"redundantvpcrouter"` Regionlevelvpc bool `json:"regionlevelvpc"` Restartrequired bool `json:"restartrequired"` diff --git a/cloudstack/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index 2386d135..3fe940ed 100644 --- a/cloudstack/VirtualMachineService.go +++ b/cloudstack/VirtualMachineService.go @@ -239,6 +239,8 @@ func (s *VirtualMachineService) AddNicToVirtualMachine(p *AddNicToVirtualMachine type AddNicToVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []AddNicToVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -264,6 +266,7 @@ type AddNicToVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -309,6 +312,11 @@ type AddNicToVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -534,6 +542,8 @@ func (s *VirtualMachineService) AssignVirtualMachine(p *AssignVirtualMachinePara type AssignVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []AssignVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -559,6 +569,7 @@ type AssignVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -604,6 +615,11 @@ type AssignVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -835,7 +851,7 @@ func (s *VirtualMachineService) NewChangeServiceForVirtualMachineParams(id strin return p } -// Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect. Note that it only changes the VM's compute offering and it does not update the root volume offering. If the Service Offering has a root disk size the volume will be resized only if using API command 'scaleVirtualMachine'. +// (This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect. func (s *VirtualMachineService) ChangeServiceForVirtualMachine(p *ChangeServiceForVirtualMachineParams) (*ChangeServiceForVirtualMachineResponse, error) { resp, err := s.cs.newRequest("changeServiceForVirtualMachine", p.toURLValues()) if err != nil { @@ -853,6 +869,8 @@ func (s *VirtualMachineService) ChangeServiceForVirtualMachine(p *ChangeServiceF type ChangeServiceForVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []ChangeServiceForVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -878,6 +896,7 @@ type ChangeServiceForVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -923,6 +942,11 @@ type ChangeServiceForVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -1149,6 +1173,13 @@ func (p *DeployVirtualMachineParams) toURLValues() url.Values { if v, found := p.p["hypervisor"]; found { u.Set("hypervisor", v.(string)) } + if v, found := p.p["iodriverpolicy"]; found { + u.Set("iodriverpolicy", v.(string)) + } + if v, found := p.p["iothreadsenabled"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("iothreadsenabled", vv) + } if v, found := p.p["ip6address"]; found { u.Set("ip6address", v.(string)) } @@ -1236,6 +1267,16 @@ func (p *DeployVirtualMachineParams) toURLValues() url.Values { if v, found := p.p["userdata"]; found { u.Set("userdata", v.(string)) } + if v, found := p.p["userdatadetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("userdatadetails[%d].key", i), k) + u.Set(fmt.Sprintf("userdatadetails[%d].value", i), m[k]) + } + } + if v, found := p.p["userdataid"]; found { + u.Set("userdataid", v.(string)) + } if v, found := p.p["zoneid"]; found { u.Set("zoneid", v.(string)) } @@ -1586,6 +1627,36 @@ func (p *DeployVirtualMachineParams) GetHypervisor() (string, bool) { return value, ok } +func (p *DeployVirtualMachineParams) SetIodriverpolicy(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["iodriverpolicy"] = v +} + +func (p *DeployVirtualMachineParams) GetIodriverpolicy() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["iodriverpolicy"].(string) + return value, ok +} + +func (p *DeployVirtualMachineParams) SetIothreadsenabled(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["iothreadsenabled"] = v +} + +func (p *DeployVirtualMachineParams) GetIothreadsenabled() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["iothreadsenabled"].(bool) + return value, ok +} + func (p *DeployVirtualMachineParams) SetIp6address(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1944,6 +2015,36 @@ func (p *DeployVirtualMachineParams) GetUserdata() (string, bool) { return value, ok } +func (p *DeployVirtualMachineParams) SetUserdatadetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdatadetails"] = v +} + +func (p *DeployVirtualMachineParams) GetUserdatadetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdatadetails"].(map[string]string) + return value, ok +} + +func (p *DeployVirtualMachineParams) SetUserdataid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdataid"] = v +} + +func (p *DeployVirtualMachineParams) GetUserdataid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdataid"].(string) + return value, ok +} + func (p *DeployVirtualMachineParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2008,6 +2109,8 @@ func (s *VirtualMachineService) DeployVirtualMachine(p *DeployVirtualMachinePara type DeployVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []DeployVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -2033,6 +2136,7 @@ type DeployVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -2078,6 +2182,11 @@ type DeployVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -2269,6 +2378,8 @@ func (s *VirtualMachineService) DestroyVirtualMachine(p *DestroyVirtualMachinePa type DestroyVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []DestroyVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -2294,6 +2405,7 @@ type DestroyVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -2339,6 +2451,11 @@ type DestroyVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -2570,6 +2687,9 @@ func (p *ListVirtualMachinesParams) toURLValues() url.Values { if v, found := p.p["affinitygroupid"]; found { u.Set("affinitygroupid", v.(string)) } + if v, found := p.p["autoscalevmgroupid"]; found { + u.Set("autoscalevmgroupid", v.(string)) + } if v, found := p.p["backupofferingid"]; found { u.Set("backupofferingid", v.(string)) } @@ -2674,6 +2794,10 @@ func (p *ListVirtualMachinesParams) toURLValues() url.Values { if v, found := p.p["templateid"]; found { u.Set("templateid", v.(string)) } + if v, found := p.p["userdata"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("userdata", vv) + } if v, found := p.p["userid"]; found { u.Set("userid", v.(string)) } @@ -2731,6 +2855,21 @@ func (p *ListVirtualMachinesParams) GetAffinitygroupid() (string, bool) { return value, ok } +func (p *ListVirtualMachinesParams) SetAutoscalevmgroupid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["autoscalevmgroupid"] = v +} + +func (p *ListVirtualMachinesParams) GetAutoscalevmgroupid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["autoscalevmgroupid"].(string) + return value, ok +} + func (p *ListVirtualMachinesParams) SetBackupofferingid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3181,6 +3320,21 @@ func (p *ListVirtualMachinesParams) GetTemplateid() (string, bool) { return value, ok } +func (p *ListVirtualMachinesParams) SetUserdata(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdata"] = v +} + +func (p *ListVirtualMachinesParams) GetUserdata() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdata"].(bool) + return value, ok +} + func (p *ListVirtualMachinesParams) SetUserid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3340,6 +3494,8 @@ type ListVirtualMachinesResponse struct { type VirtualMachine struct { Account string `json:"account"` Affinitygroup []VirtualMachineAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -3365,6 +3521,7 @@ type VirtualMachine struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -3410,6 +3567,11 @@ type VirtualMachine struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -3505,6 +3667,9 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { if v, found := p.p["affinitygroupid"]; found { u.Set("affinitygroupid", v.(string)) } + if v, found := p.p["autoscalevmgroupid"]; found { + u.Set("autoscalevmgroupid", v.(string)) + } if v, found := p.p["backupofferingid"]; found { u.Set("backupofferingid", v.(string)) } @@ -3609,6 +3774,10 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { if v, found := p.p["templateid"]; found { u.Set("templateid", v.(string)) } + if v, found := p.p["userdata"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("userdata", vv) + } if v, found := p.p["userid"]; found { u.Set("userid", v.(string)) } @@ -3666,6 +3835,21 @@ func (p *ListVirtualMachinesMetricsParams) GetAffinitygroupid() (string, bool) { return value, ok } +func (p *ListVirtualMachinesMetricsParams) SetAutoscalevmgroupid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["autoscalevmgroupid"] = v +} + +func (p *ListVirtualMachinesMetricsParams) GetAutoscalevmgroupid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["autoscalevmgroupid"].(string) + return value, ok +} + func (p *ListVirtualMachinesMetricsParams) SetBackupofferingid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4116,6 +4300,21 @@ func (p *ListVirtualMachinesMetricsParams) GetTemplateid() (string, bool) { return value, ok } +func (p *ListVirtualMachinesMetricsParams) SetUserdata(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdata"] = v +} + +func (p *ListVirtualMachinesMetricsParams) GetUserdata() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdata"].(bool) + return value, ok +} + func (p *ListVirtualMachinesMetricsParams) SetUserid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4275,6 +4474,8 @@ type ListVirtualMachinesMetricsResponse struct { type VirtualMachinesMetric struct { Account string `json:"account"` Affinitygroup []VirtualMachinesMetricAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -4304,6 +4505,7 @@ type VirtualMachinesMetric struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -4353,6 +4555,11 @@ type VirtualMachinesMetric struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -4561,6 +4768,8 @@ func (s *VirtualMachineService) MigrateVirtualMachine(p *MigrateVirtualMachinePa type MigrateVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []MigrateVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -4586,6 +4795,7 @@ type MigrateVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -4631,6 +4841,11 @@ type MigrateVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -4839,6 +5054,8 @@ func (s *VirtualMachineService) MigrateVirtualMachineWithVolume(p *MigrateVirtua type MigrateVirtualMachineWithVolumeResponse struct { Account string `json:"account"` Affinitygroup []MigrateVirtualMachineWithVolumeResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -4864,6 +5081,7 @@ type MigrateVirtualMachineWithVolumeResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -4909,6 +5127,11 @@ type MigrateVirtualMachineWithVolumeResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -5100,6 +5323,8 @@ func (s *VirtualMachineService) RebootVirtualMachine(p *RebootVirtualMachinePara type RebootVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []RebootVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -5125,6 +5350,7 @@ type RebootVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -5170,6 +5396,11 @@ type RebootVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -5303,6 +5534,8 @@ func (s *VirtualMachineService) RecoverVirtualMachine(p *RecoverVirtualMachinePa type RecoverVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []RecoverVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -5328,6 +5561,7 @@ type RecoverVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -5373,6 +5607,11 @@ type RecoverVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -5545,6 +5784,8 @@ func (s *VirtualMachineService) RemoveNicFromVirtualMachine(p *RemoveNicFromVirt type RemoveNicFromVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []RemoveNicFromVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -5570,6 +5811,7 @@ type RemoveNicFromVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -5615,6 +5857,11 @@ type RemoveNicFromVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -5768,6 +6015,8 @@ func (s *VirtualMachineService) ResetPasswordForVirtualMachine(p *ResetPasswordF type ResetPasswordForVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []ResetPasswordForVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -5793,6 +6042,7 @@ type ResetPasswordForVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -5838,6 +6088,11 @@ type ResetPasswordForVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -6009,6 +6264,8 @@ func (s *VirtualMachineService) RestoreVirtualMachine(p *RestoreVirtualMachinePa type RestoreVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []RestoreVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -6034,6 +6291,7 @@ type RestoreVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -6079,6 +6337,11 @@ type RestoreVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -6310,7 +6573,7 @@ func (s *VirtualMachineService) NewScaleVirtualMachineParams(id string, serviceo return p } -// Scales the virtual machine to a new service offering. This command also takes into account the Volume and it may resize the root disk size according to the service offering. +// Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume. func (s *VirtualMachineService) ScaleVirtualMachine(p *ScaleVirtualMachineParams) (*ScaleVirtualMachineResponse, error) { resp, err := s.cs.newRequest("scaleVirtualMachine", p.toURLValues()) if err != nil { @@ -6363,6 +6626,10 @@ func (p *StartVirtualMachineParams) toURLValues() url.Values { if v, found := p.p["clusterid"]; found { u.Set("clusterid", v.(string)) } + if v, found := p.p["considerlasthost"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("considerlasthost", vv) + } if v, found := p.p["deploymentplanner"]; found { u.Set("deploymentplanner", v.(string)) } @@ -6408,6 +6675,21 @@ func (p *StartVirtualMachineParams) GetClusterid() (string, bool) { return value, ok } +func (p *StartVirtualMachineParams) SetConsiderlasthost(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["considerlasthost"] = v +} + +func (p *StartVirtualMachineParams) GetConsiderlasthost() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["considerlasthost"].(bool) + return value, ok +} + func (p *StartVirtualMachineParams) SetDeploymentplanner(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -6515,6 +6797,8 @@ func (s *VirtualMachineService) StartVirtualMachine(p *StartVirtualMachineParams type StartVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []StartVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -6540,6 +6824,7 @@ type StartVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -6585,6 +6870,11 @@ type StartVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -6757,6 +7047,8 @@ func (s *VirtualMachineService) StopVirtualMachine(p *StopVirtualMachineParams) type StopVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []StopVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -6782,6 +7074,7 @@ type StopVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -6827,6 +7120,11 @@ type StopVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -6999,6 +7297,8 @@ func (s *VirtualMachineService) UpdateDefaultNicForVirtualMachine(p *UpdateDefau type UpdateDefaultNicForVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []UpdateDefaultNicForVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -7024,6 +7324,7 @@ type UpdateDefaultNicForVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -7069,6 +7370,11 @@ type UpdateDefaultNicForVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` @@ -7219,6 +7525,16 @@ func (p *UpdateVirtualMachineParams) toURLValues() url.Values { if v, found := p.p["userdata"]; found { u.Set("userdata", v.(string)) } + if v, found := p.p["userdatadetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("userdatadetails[%d].key", i), k) + u.Set(fmt.Sprintf("userdatadetails[%d].value", i), m[k]) + } + } + if v, found := p.p["userdataid"]; found { + u.Set("userdataid", v.(string)) + } return u } @@ -7491,6 +7807,36 @@ func (p *UpdateVirtualMachineParams) GetUserdata() (string, bool) { return value, ok } +func (p *UpdateVirtualMachineParams) SetUserdatadetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdatadetails"] = v +} + +func (p *UpdateVirtualMachineParams) GetUserdatadetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdatadetails"].(map[string]string) + return value, ok +} + +func (p *UpdateVirtualMachineParams) SetUserdataid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdataid"] = v +} + +func (p *UpdateVirtualMachineParams) GetUserdataid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdataid"].(string) + return value, ok +} + // You should always use this function to get a new UpdateVirtualMachineParams instance, // as then you are sure you have configured all required params func (s *VirtualMachineService) NewUpdateVirtualMachineParams(id string) *UpdateVirtualMachineParams { @@ -7518,6 +7864,8 @@ func (s *VirtualMachineService) UpdateVirtualMachine(p *UpdateVirtualMachinePara type UpdateVirtualMachineResponse struct { Account string `json:"account"` Affinitygroup []UpdateVirtualMachineResponseAffinitygroup `json:"affinitygroup"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` Backupofferingid string `json:"backupofferingid"` Backupofferingname string `json:"backupofferingname"` Bootmode string `json:"bootmode"` @@ -7543,6 +7891,7 @@ type UpdateVirtualMachineResponse struct { Guestosid string `json:"guestosid"` Haenable bool `json:"haenable"` Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` Hostid string `json:"hostid"` Hostname string `json:"hostname"` Hypervisor string `json:"hypervisor"` @@ -7588,6 +7937,11 @@ type UpdateVirtualMachineResponse struct { Templatedisplaytext string `json:"templatedisplaytext"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` diff --git a/cloudstack/VolumeService.go b/cloudstack/VolumeService.go index 727a4c19..a1ff906e 100644 --- a/cloudstack/VolumeService.go +++ b/cloudstack/VolumeService.go @@ -250,6 +250,7 @@ type AttachVolumeResponse struct { Vmdisplayname string `json:"vmdisplayname"` Vmname string `json:"vmname"` Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -613,6 +614,7 @@ type CreateVolumeResponse struct { Vmdisplayname string `json:"vmdisplayname"` Vmname string `json:"vmname"` Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -864,6 +866,7 @@ type DestroyVolumeResponse struct { Vmdisplayname string `json:"vmdisplayname"` Vmname string `json:"vmname"` Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -1044,6 +1047,7 @@ type DetachVolumeResponse struct { Vmdisplayname string `json:"vmdisplayname"` Vmname string `json:"vmname"` Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -1636,6 +1640,10 @@ func (p *ListVolumesParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("listall", vv) } + if v, found := p.p["listsystemvms"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("listsystemvms", vv) + } if v, found := p.p["name"]; found { u.Set("name", v.(string)) } @@ -1843,6 +1851,21 @@ func (p *ListVolumesParams) GetListall() (bool, bool) { return value, ok } +func (p *ListVolumesParams) SetListsystemvms(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["listsystemvms"] = v +} + +func (p *ListVolumesParams) GetListsystemvms() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["listsystemvms"].(bool) + return value, ok +} + func (p *ListVolumesParams) SetName(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2185,6 +2208,7 @@ type Volume struct { Vmdisplayname string `json:"vmdisplayname"` Vmname string `json:"vmname"` Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -2235,6 +2259,10 @@ func (p *ListVolumesMetricsParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("listall", vv) } + if v, found := p.p["listsystemvms"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("listsystemvms", vv) + } if v, found := p.p["name"]; found { u.Set("name", v.(string)) } @@ -2442,6 +2470,21 @@ func (p *ListVolumesMetricsParams) GetListall() (bool, bool) { return value, ok } +func (p *ListVolumesMetricsParams) SetListsystemvms(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["listsystemvms"] = v +} + +func (p *ListVolumesMetricsParams) GetListsystemvms() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["listsystemvms"].(bool) + return value, ok +} + func (p *ListVolumesMetricsParams) SetName(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2786,6 +2829,7 @@ type VolumesMetric struct { Vmdisplayname string `json:"vmdisplayname"` Vmname string `json:"vmname"` Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -2986,6 +3030,7 @@ type MigrateVolumeResponse struct { Vmdisplayname string `json:"vmdisplayname"` Vmname string `json:"vmname"` Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -3110,6 +3155,7 @@ type RecoverVolumeResponse struct { Vmdisplayname string `json:"vmdisplayname"` Vmname string `json:"vmname"` Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -3348,6 +3394,7 @@ type ResizeVolumeResponse struct { Vmdisplayname string `json:"vmdisplayname"` Vmname string `json:"vmname"` Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -3618,6 +3665,7 @@ type UpdateVolumeResponse struct { Vmdisplayname string `json:"vmdisplayname"` Vmname string `json:"vmname"` Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -3927,6 +3975,7 @@ type UploadVolumeResponse struct { Vmdisplayname string `json:"vmdisplayname"` Vmname string `json:"vmname"` Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -4185,6 +4234,7 @@ type ChangeOfferingForVolumeResponse struct { Vmdisplayname string `json:"vmdisplayname"` Vmname string `json:"vmname"` Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } diff --git a/cloudstack/ZoneService.go b/cloudstack/ZoneService.go index cc067a73..96359a26 100644 --- a/cloudstack/ZoneService.go +++ b/cloudstack/ZoneService.go @@ -99,6 +99,10 @@ func (p *CreateZoneParams) toURLValues() url.Values { if v, found := p.p["ip6dns2"]; found { u.Set("ip6dns2", v.(string)) } + if v, found := p.p["isedge"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("isedge", vv) + } if v, found := p.p["localstorageenabled"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("localstorageenabled", vv) @@ -266,6 +270,21 @@ func (p *CreateZoneParams) GetIp6dns2() (string, bool) { return value, ok } +func (p *CreateZoneParams) SetIsedge(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isedge"] = v +} + +func (p *CreateZoneParams) GetIsedge() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isedge"].(bool) + return value, ok +} + func (p *CreateZoneParams) SetLocalstorageenabled(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -354,33 +373,37 @@ func (s *ZoneService) CreateZone(p *CreateZoneParams) (*CreateZoneResponse, erro } type CreateZoneResponse struct { - Allocationstate string `json:"allocationstate"` - Capacity []CreateZoneResponseCapacity `json:"capacity"` - Description string `json:"description"` - Dhcpprovider string `json:"dhcpprovider"` - Displaytext string `json:"displaytext"` - Dns1 string `json:"dns1"` - Dns2 string `json:"dns2"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Domainname string `json:"domainname"` - Guestcidraddress string `json:"guestcidraddress"` - Hasannotations bool `json:"hasannotations"` - Icon interface{} `json:"icon"` - Id string `json:"id"` - Internaldns1 string `json:"internaldns1"` - Internaldns2 string `json:"internaldns2"` - Ip6dns1 string `json:"ip6dns1"` - Ip6dns2 string `json:"ip6dns2"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Localstorageenabled bool `json:"localstorageenabled"` - Name string `json:"name"` - Networktype string `json:"networktype"` - Resourcedetails map[string]string `json:"resourcedetails"` - Securitygroupsenabled bool `json:"securitygroupsenabled"` - Tags []Tags `json:"tags"` - Zonetoken string `json:"zonetoken"` + Allocationstate string `json:"allocationstate"` + Allowuserspecifyvrmtu bool `json:"allowuserspecifyvrmtu"` + Capacity []CreateZoneResponseCapacity `json:"capacity"` + Description string `json:"description"` + Dhcpprovider string `json:"dhcpprovider"` + Displaytext string `json:"displaytext"` + Dns1 string `json:"dns1"` + Dns2 string `json:"dns2"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainname string `json:"domainname"` + Guestcidraddress string `json:"guestcidraddress"` + Hasannotations bool `json:"hasannotations"` + Icon interface{} `json:"icon"` + Id string `json:"id"` + Internaldns1 string `json:"internaldns1"` + Internaldns2 string `json:"internaldns2"` + Ip6dns1 string `json:"ip6dns1"` + Ip6dns2 string `json:"ip6dns2"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Localstorageenabled bool `json:"localstorageenabled"` + Name string `json:"name"` + Networktype string `json:"networktype"` + Resourcedetails map[string]string `json:"resourcedetails"` + Routerprivateinterfacemaxmtu int `json:"routerprivateinterfacemaxmtu"` + Routerpublicinterfacemaxmtu int `json:"routerpublicinterfacemaxmtu"` + Securitygroupsenabled bool `json:"securitygroupsenabled"` + Tags []Tags `json:"tags"` + Type string `json:"type"` + Zonetoken string `json:"zonetoken"` } type CreateZoneResponseCapacity struct { @@ -1450,33 +1473,37 @@ type ListZonesResponse struct { } type Zone struct { - Allocationstate string `json:"allocationstate"` - Capacity []ZoneCapacity `json:"capacity"` - Description string `json:"description"` - Dhcpprovider string `json:"dhcpprovider"` - Displaytext string `json:"displaytext"` - Dns1 string `json:"dns1"` - Dns2 string `json:"dns2"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Domainname string `json:"domainname"` - Guestcidraddress string `json:"guestcidraddress"` - Hasannotations bool `json:"hasannotations"` - Icon interface{} `json:"icon"` - Id string `json:"id"` - Internaldns1 string `json:"internaldns1"` - Internaldns2 string `json:"internaldns2"` - Ip6dns1 string `json:"ip6dns1"` - Ip6dns2 string `json:"ip6dns2"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Localstorageenabled bool `json:"localstorageenabled"` - Name string `json:"name"` - Networktype string `json:"networktype"` - Resourcedetails map[string]string `json:"resourcedetails"` - Securitygroupsenabled bool `json:"securitygroupsenabled"` - Tags []Tags `json:"tags"` - Zonetoken string `json:"zonetoken"` + Allocationstate string `json:"allocationstate"` + Allowuserspecifyvrmtu bool `json:"allowuserspecifyvrmtu"` + Capacity []ZoneCapacity `json:"capacity"` + Description string `json:"description"` + Dhcpprovider string `json:"dhcpprovider"` + Displaytext string `json:"displaytext"` + Dns1 string `json:"dns1"` + Dns2 string `json:"dns2"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainname string `json:"domainname"` + Guestcidraddress string `json:"guestcidraddress"` + Hasannotations bool `json:"hasannotations"` + Icon interface{} `json:"icon"` + Id string `json:"id"` + Internaldns1 string `json:"internaldns1"` + Internaldns2 string `json:"internaldns2"` + Ip6dns1 string `json:"ip6dns1"` + Ip6dns2 string `json:"ip6dns2"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Localstorageenabled bool `json:"localstorageenabled"` + Name string `json:"name"` + Networktype string `json:"networktype"` + Resourcedetails map[string]string `json:"resourcedetails"` + Routerprivateinterfacemaxmtu int `json:"routerprivateinterfacemaxmtu"` + Routerpublicinterfacemaxmtu int `json:"routerpublicinterfacemaxmtu"` + Securitygroupsenabled bool `json:"securitygroupsenabled"` + Tags []Tags `json:"tags"` + Type string `json:"type"` + Zonetoken string `json:"zonetoken"` } type ZoneCapacity struct { @@ -1826,6 +1853,7 @@ type ListZonesMetricsResponse struct { type ZonesMetric struct { Allocationstate string `json:"allocationstate"` + Allowuserspecifyvrmtu bool `json:"allowuserspecifyvrmtu"` Capacity []ZonesMetricCapacity `json:"capacity"` Clusters string `json:"clusters"` Cpuallocated string `json:"cpuallocated"` @@ -1866,9 +1894,12 @@ type ZonesMetric struct { Name string `json:"name"` Networktype string `json:"networktype"` Resourcedetails map[string]string `json:"resourcedetails"` + Routerprivateinterfacemaxmtu int `json:"routerprivateinterfacemaxmtu"` + Routerpublicinterfacemaxmtu int `json:"routerpublicinterfacemaxmtu"` Securitygroupsenabled bool `json:"securitygroupsenabled"` State string `json:"state"` Tags []Tags `json:"tags"` + Type string `json:"type"` Zonetoken string `json:"zonetoken"` } @@ -2314,33 +2345,37 @@ func (s *ZoneService) UpdateZone(p *UpdateZoneParams) (*UpdateZoneResponse, erro } type UpdateZoneResponse struct { - Allocationstate string `json:"allocationstate"` - Capacity []UpdateZoneResponseCapacity `json:"capacity"` - Description string `json:"description"` - Dhcpprovider string `json:"dhcpprovider"` - Displaytext string `json:"displaytext"` - Dns1 string `json:"dns1"` - Dns2 string `json:"dns2"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Domainname string `json:"domainname"` - Guestcidraddress string `json:"guestcidraddress"` - Hasannotations bool `json:"hasannotations"` - Icon interface{} `json:"icon"` - Id string `json:"id"` - Internaldns1 string `json:"internaldns1"` - Internaldns2 string `json:"internaldns2"` - Ip6dns1 string `json:"ip6dns1"` - Ip6dns2 string `json:"ip6dns2"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Localstorageenabled bool `json:"localstorageenabled"` - Name string `json:"name"` - Networktype string `json:"networktype"` - Resourcedetails map[string]string `json:"resourcedetails"` - Securitygroupsenabled bool `json:"securitygroupsenabled"` - Tags []Tags `json:"tags"` - Zonetoken string `json:"zonetoken"` + Allocationstate string `json:"allocationstate"` + Allowuserspecifyvrmtu bool `json:"allowuserspecifyvrmtu"` + Capacity []UpdateZoneResponseCapacity `json:"capacity"` + Description string `json:"description"` + Dhcpprovider string `json:"dhcpprovider"` + Displaytext string `json:"displaytext"` + Dns1 string `json:"dns1"` + Dns2 string `json:"dns2"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainname string `json:"domainname"` + Guestcidraddress string `json:"guestcidraddress"` + Hasannotations bool `json:"hasannotations"` + Icon interface{} `json:"icon"` + Id string `json:"id"` + Internaldns1 string `json:"internaldns1"` + Internaldns2 string `json:"internaldns2"` + Ip6dns1 string `json:"ip6dns1"` + Ip6dns2 string `json:"ip6dns2"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Localstorageenabled bool `json:"localstorageenabled"` + Name string `json:"name"` + Networktype string `json:"networktype"` + Resourcedetails map[string]string `json:"resourcedetails"` + Routerprivateinterfacemaxmtu int `json:"routerprivateinterfacemaxmtu"` + Routerpublicinterfacemaxmtu int `json:"routerpublicinterfacemaxmtu"` + Securitygroupsenabled bool `json:"securitygroupsenabled"` + Tags []Tags `json:"tags"` + Type string `json:"type"` + Zonetoken string `json:"zonetoken"` } type UpdateZoneResponseCapacity struct { diff --git a/generate/listApis.json b/generate/listApis.json index c50262ca..f611d986 100644 --- a/generate/listApis.json +++ b/generate/listApis.json @@ -6,38 +6,38 @@ "name": "listResourceIcon", "params": [ { - "description": "list of resources to upload the icon/image for", + "description": "type of the resource", "length": 255, - "name": "resourceids", + "name": "resourcetype", "required": true, - "type": "list" + "type": "string" }, { - "description": "type of the resource", + "description": "list of resources to upload the icon/image for", "length": 255, - "name": "resourcetype", + "name": "resourceids", "required": true, - "type": "string" + "type": "list" } ], "related": "", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "resourceobjecttype" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "base64 representation of resource icon", - "name": "base64image", - "type": "string" + "description": "resource type", + "name": "resourcetype", + "type": "resourceobjecttype" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -45,9 +45,9 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "base64 representation of resource icon", + "name": "base64image", + "type": "string" } ], "since": "4.16.0.0" @@ -58,13 +58,12 @@ "name": "createVPCOffering", "params": [ { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "the ID of the service offering for the VPC router appliance", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.13", - "type": "list" + "type": "uuid" }, { "description": "the display text of the vpc offering", @@ -73,13 +72,6 @@ "required": true, "type": "string" }, - { - "description": "the name of the vpc offering", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "desired service capabilities as part of vpc offering", "length": 255, @@ -96,6 +88,13 @@ "required": false, "type": "list" }, + { + "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", + "length": 255, + "name": "serviceproviderlist", + "required": false, + "type": "map" + }, { "description": "The 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, @@ -104,6 +103,13 @@ "since": "4.17.0", "type": "string" }, + { + "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, @@ -113,12 +119,13 @@ "type": "boolean" }, { - "description": "the ID of the service offering for the VPC router appliance", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "uuid" + "since": "4.13", + "type": "list" }, { "description": "services supported by the vpc offering", @@ -126,36 +133,35 @@ "name": "supportedservices", "required": true, "type": "list" - }, - { - "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", - "length": 255, - "name": "serviceproviderlist", - "required": false, - "type": "map" } ], "related": "updateVPCOffering,listVPCOfferings", "response": [ { - "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 domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, { "description": "the internet protocol of the vpc offering", "name": "internetprotocol", "type": "string" }, + { + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" + }, + {}, {}, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "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", "type": "string" }, { @@ -164,8 +170,8 @@ "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { @@ -174,8 +180,8 @@ "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -183,38 +189,32 @@ "name": "id", "type": "string" }, - {}, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, { "description": "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": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, { - "description": "state of the network provider", - "name": "state", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -223,23 +223,23 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "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", @@ -250,13 +250,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" } ], @@ -265,30 +265,30 @@ ], "type": "list" }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" - }, { "description": "the name of the vpc offering", "name": "name", "type": "string" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", + "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" } ] }, @@ -298,53 +298,53 @@ "name": "createPod", "params": [ { - "description": "the starting IP address for the Pod", + "description": "the name of the Pod", "length": 255, - "name": "startip", + "name": "name", "required": true, "type": "string" }, { - "description": "the gateway for the Pod", + "description": "the starting IP address for the Pod", "length": 255, - "name": "gateway", - "required": true, + "name": "startip", + "required": false, "type": "string" }, { - "description": "the name of the Pod", + "description": "the Zone ID in which the Pod will be created", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the ending IP address for the Pod", + "description": "the netmask for the Pod", "length": 255, - "name": "endip", + "name": "netmask", "required": false, "type": "string" }, { - "description": "Allocation state of this Pod for allocation of new resources", + "description": "the gateway for the Pod", "length": 255, - "name": "allocationstate", + "name": "gateway", "required": false, "type": "string" }, { - "description": "the Zone ID in which the Pod will be created", + "description": "the ending IP address for the Pod", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "endip", + "required": false, + "type": "string" }, { - "description": "the netmask for the Pod", + "description": "Allocation state of this Pod for allocation of new resources", "length": 255, - "name": "netmask", - "required": true, + "name": "allocationstate", + "required": false, "type": "string" } ], @@ -355,30 +355,40 @@ "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the Pod", - "name": "name", - "type": "string" + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" }, + {}, { "description": "the capacity of the Pod", "name": "capacity", "response": [ + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, { "description": "the Cluster ID", "name": "clusterid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" }, { "description": "the capacity type", @@ -386,24 +396,19 @@ "type": "short" }, { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the capacity name", @@ -411,24 +416,19 @@ "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Pod ID", + "name": "podid", + "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" } ], "type": "list" @@ -439,53 +439,63 @@ "type": "string" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the netmask of the Pod", + "name": "netmask", "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 Zone ID of the Pod", + "name": "zoneid", + "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 name of the Pod", + "name": "name", + "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": "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 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 netmask of the Pod", - "name": "netmask", + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the IP ranges for the Pod", "name": "ipranges", "response": [ { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { @@ -499,8 +509,8 @@ "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { @@ -509,22 +519,12 @@ "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" } ], "type": "list" - }, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -534,9 +534,9 @@ "name": "ldapCreateAccount", "params": [ { - "description": "Network domain for the account's networks", + "description": "Account UUID, required for adding account from external provisioning system", "length": 255, - "name": "networkdomain", + "name": "accountid", "required": false, "type": "string" }, @@ -548,12 +548,18 @@ "type": "string" }, { - "description": "Creates the user under the specified domain.", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "accounttype", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "Network domain for the account's networks", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" }, { "description": "Creates the account under the specified role.", @@ -564,11 +570,19 @@ "type": "uuid" }, { - "description": "Account UUID, required for adding account from external provisioning system", + "description": "details for account used to store specific parameters", "length": 255, - "name": "accountid", + "name": "accountdetails", "required": false, - "type": "string" + "type": "map" + }, + { + "description": "Creates the user under the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" }, { "description": "Unique username.", @@ -577,13 +591,6 @@ "required": true, "type": "string" }, - { - "description": "details for account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" - }, { "description": "User UUID, required for adding account from external provisioning system", "length": 255, @@ -597,31 +604,39 @@ "name": "account", "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": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { "description": "the total number of cpu cores available to be created for this account", @@ -629,55 +644,68 @@ "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, - {}, { - "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" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, - {}, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "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", + "description": "the total number of networks the account can own", + "name": "networklimit", "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", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { @@ -686,49 +714,50 @@ "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "type": "integer" }, { - "description": "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 projects available for administration by this account", - "name": "projectavailable", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "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 virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, + {}, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, { "description": "the total number of public ip addresses this account can acquire", @@ -736,13 +765,23 @@ "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { @@ -751,18 +790,18 @@ "type": "list" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { @@ -771,92 +810,87 @@ "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", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the api key of the user", - "name": "apikey", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the user ID", - "name": "id", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user email address", + "name": "email", "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 boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { @@ -865,29 +899,29 @@ "type": "resourceiconresponse" }, { - "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" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { "description": "the name of the role", @@ -895,136 +929,112 @@ "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the user state", + "name": "state", "type": "string" } ], "type": "list" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "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 date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "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 date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the id of the account", - "name": "id", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, + {}, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" } ], @@ -1044,6 +1054,13 @@ } ], "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", @@ -1054,13 +1071,6 @@ "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", @@ -1075,17 +1085,17 @@ "name": "copyIso", "params": [ { - "description": "Template ID.", + "description": "ID of the zone the template is being copied to.", "length": 255, - "name": "id", - "related": "prepareTemplate,copyIso,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, + "name": "destzoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, "type": "uuid" }, { - "description": "ID of the zone the template is being copied to.", + "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", "length": 255, - "name": "destzoneid", + "name": "sourcezoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" @@ -1099,39 +1109,81 @@ "type": "list" }, { - "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", + "description": "Template ID.", "length": 255, - "name": "sourcezoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "id", + "related": "prepareTemplate,copyIso,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, "type": "uuid" } ], - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], "type": "set" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -1140,88 +1192,73 @@ "type": "int" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the template name", - "name": "name", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the name of the domain to which the template belongs", + "name": "domain", "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 ID of the zone for this template", - "name": "zoneid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the template ID", - "name": "id", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, { "description": "the project name of the template", "name": "project", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { @@ -1229,129 +1266,105 @@ "name": "accountid", "type": "string" }, - {}, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "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 physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, - {}, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "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 format of the template.", - "name": "format", - "type": "imageformat" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "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 size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "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": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "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 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": "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" - }, - { - "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": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { "description": "VMware only: additional key/value details tied with deploy-as-is template", @@ -1359,13 +1372,14 @@ "type": "map" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, + {}, { - "description": "the type of the template", - "name": "templatetype", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { @@ -1374,45 +1388,61 @@ "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", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, { "description": "the date this template was removed", "name": "removed", "type": "date" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "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 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": "checksum of the template", - "name": "checksum", - "type": "string" - } + {} ] }, { @@ -1435,18 +1465,18 @@ "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -1459,21 +1489,21 @@ "isasync": true, "name": "provisionCertificate", "params": [ - { - "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used", - "length": 255, - "name": "reconnect", - "required": false, - "type": "boolean" - }, { "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", "length": 255, "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "required": true, "type": "uuid" }, + { + "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used", + "length": 255, + "name": "reconnect", + "required": false, + "type": "boolean" + }, { "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, @@ -1483,7 +1513,11 @@ } ], "response": [ - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -1495,135 +1529,94 @@ "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.11.0" }, { - "description": "Adds an external firewall appliance", + "description": "Lists VM metrics", "isasync": false, - "name": "addExternalFirewall", + "name": "listVirtualMachinesMetrics", "params": [ { - "description": "Password of the external firewall appliance.", + "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": "password", - "required": true, + "name": "state", + "required": false, "type": "string" }, { - "description": "Username of the external firewall appliance.", + "description": "the host ID", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "required": false, + "type": "uuid" }, { - "description": "URL of the external firewall appliance.", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "url", - "required": true, - "type": "string" + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" }, { - "description": "Zone in which to add the external firewall appliance.", + "description": "list vms by ssh keypair name", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "listExternalFirewalls", - "response": [ - { - "description": "the public interface of the external firewall", - "name": "publicinterface", - "type": "string" - }, - { - "description": "the public security zone of the external firewall", - "name": "publiczone", - "type": "string" - }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" - }, - {}, - { - "description": "the zone ID of the external firewall", - "name": "zoneid", - "type": "string" - }, - { - "description": "the ID of the external firewall", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "name": "keypair", + "required": false, "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", - "type": "string" + "description": "the group ID", + "length": 255, + "name": "groupid", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, - {}, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", - "type": "string" + "description": "the user ID that created the VM and is under the account that owns the VM", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "type": "uuid" }, { - "description": "the ID of the network device", - "name": "id", - "type": "string" + "description": "list vms by iso", + "length": 255, + "name": "isoid", + "required": false, + "type": "uuid" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", - "type": "string" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" - } - ] - }, - { - "description": "Lists VM metrics", - "isasync": false, - "name": "listVirtualMachinesMetrics", - "params": [ { "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, @@ -1633,169 +1626,157 @@ "type": "boolean" }, { - "description": "list by the service offering", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.4", - "type": "uuid" - }, - { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list vms by ssh keypair name", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "keypair", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "list vms by template", + "description": "list vms by vpc", "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "the group ID", + "description": "list by the service offering", "length": 255, - "name": "groupid", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools", "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,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "backupofferingid", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "the cluster ID", + "description": "the pod ID", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", "length": 255, - "name": "isrecursive", + "name": "accumulate", "required": false, + "since": "4.17.0", "type": "boolean" }, { - "description": "", + "description": "list vms by template", "length": 255, - "name": "pagesize", + "name": "templateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list by the backup offering", + "description": "list vms by affinity group", "length": 255, - "name": "backupofferingid", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "since": "4.17", "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": "the storage ID where vm's volumes belong to", + "description": "the availability zone ID", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "state", + "name": "showicon", "required": false, - "type": "string" + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "flag to display the resource icon for VMs", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "showicon", + "name": "displayvm", "required": false, - "since": "4.16.0.0", + "since": "4.4", "type": "boolean" }, { - "description": "list by network id", + "description": "the ID of the virtual machine", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "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,importUnmanagedInstance", "required": false, "type": "uuid" }, { - "description": "the availability zone ID", + "description": "the cluster ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. 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 vms by vpc", + "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": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "the target hypervisor for the template", "length": 255, - "name": "keyword", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "forvirtualnetwork", + "name": "isrecursive", "required": false, "type": "boolean" }, @@ -1816,435 +1797,384 @@ "type": "uuid" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list vms by affinity group", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "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,importUnmanagedInstance", "required": false, - "type": "uuid" + "since": "4.4", + "type": "list" }, { - "description": "the host ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", - "length": 255, - "name": "accumulate", - "required": false, - "since": "4.17.0", - "type": "boolean" - }, - { - "description": "the pod ID", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "autoscalevmgroupid", + "related": "createAutoScaleVmGroup,disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "required": false, + "since": "4.18.0", "type": "uuid" }, { - "description": "list vms by iso", + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", "length": 255, - "name": "isoid", + "name": "userdata", "required": false, - "type": "uuid" + "since": "4.18.0.0", + "type": "boolean" + } + ], + "related": "listVirtualMachinesMetrics", + "response": [ + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "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 name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "displayvm", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "since": "4.4", - "type": "list" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" - } - ], - "related": "listVirtualMachinesMetrics", - "response": [ + }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "disk write in MiB", + "name": "diskwrite", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "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": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + {}, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "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", + "description": "the name of the affinity group", + "name": "name", "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "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": "macaddress", - "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" } ], "type": "set" }, { - "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 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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "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": "network read in MiB", + "name": "networkread", + "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 project id of the vm", - "name": "projectid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "disk write in MiB", - "name": "diskwrite", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, - {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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 date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "network write in MiB", + "name": "networkwrite", "type": "string" }, - {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the total memory capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "disk read in MiB", + "name": "diskread", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -2253,189 +2183,76 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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": "the total disk iops", - "name": "diskiopstotal", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "network write in MiB", - "name": "networkwrite", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "network read in MiB", - "name": "networkread", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, - {}, { "description": "Guest vm Boot Type", "name": "boottype", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { @@ -2444,91 +2261,46 @@ "type": "string" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotal", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "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": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "disk read in MiB", - "name": "diskread", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "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": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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" }, { @@ -2537,8 +2309,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -2547,62 +2319,52 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the domain 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": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", @@ -2613,43 +2375,33 @@ "name": "icmptype", "type": "integer" }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -2658,38 +2410,58 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "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": "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the 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", @@ -2699,81 +2471,51 @@ "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the description of the security group", + "name": "description", "type": "string" }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the 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 project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -2782,113 +2524,134 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "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 protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", - "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 account owning the security group", - "name": "account", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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": "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 amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { "description": "the group name of the virtual machine", @@ -2900,91 +2663,251 @@ "name": "publicipid", "type": "string" }, + {}, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - } - ] - }, - { - "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, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + } + ], + "type": "set" }, { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", - "length": 255, - "name": "details", - "required": false, - "type": "list" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the host type", - "length": 255, - "name": "type", - "required": false, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "lists hosts existing in particular cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", - "required": false, - "type": "uuid" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the id of the host", - "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", - "required": false, - "type": "uuid" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the host", + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + } + ] + }, + { + "description": "Lists hosts.", + "isasync": false, + "name": "listHosts", + "params": [ + { + "description": "the Pod ID for the host", "length": 255, - "name": "name", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "hahost", + "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,importUnmanagedInstance", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -3008,9 +2931,23 @@ "type": "string" }, { - "description": "the state of the host", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "state", + "name": "outofbandmanagementenabled", + "required": false, + "type": "boolean" + }, + { + "description": "if true, list only hosts dedicated to HA", + "length": 255, + "name": "hahost", + "required": false, + "type": "boolean" + }, + { + "description": "the host type", + "length": 255, + "name": "type", "required": false, "type": "string" }, @@ -3029,60 +2966,69 @@ "type": "string" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "the id of the host", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "required": false, "type": "uuid" - } - ], - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", - "response": [ - { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the name of the host", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the state of the host", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "length": 255, + "name": "details", + "required": false, + "type": "list" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the Zone ID for the host", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" - }, + "description": "lists hosts existing in particular cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", + "required": false, + "type": "uuid" + } + ], + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "response": [ { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { "description": "the amount of the host's memory currently allocated in percentage", @@ -3090,43 +3036,34 @@ "type": "string" }, { - "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": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the host version", - "name": "version", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Pod ID of the host", + "name": "podid", + "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 bytes", + "name": "memoryallocatedbytes", + "type": "long" }, + {}, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { @@ -3135,74 +3072,64 @@ "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "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 host version", + "name": "version", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { "description": "Host details in key/value pairs.", @@ -3210,77 +3137,35 @@ "type": "map" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, - {}, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { "description": "the host hypervisor", "name": "hypervisor", "type": "hypervisortype" }, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, { "description": "GPU cards present in the host", "name": "gpugroup", @@ -3290,28 +3175,28 @@ "name": "vgpu", "response": [ { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { @@ -3320,14 +3205,14 @@ "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" } ], "type": "list" @@ -3341,29 +3226,64 @@ "type": "list" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "true if 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 supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -3371,34 +3291,100 @@ "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { "description": "the last annotation set on this host by an admin", "name": "annotation", "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 out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", + "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 removed", + "name": "removed", + "type": "date" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, { "description": "the host type", "name": "type", "type": "type" }, { - "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 amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -3424,18 +3410,13 @@ } ], "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", @@ -3445,6 +3426,11 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -3453,10 +3439,17 @@ "isasync": false, "name": "listVsphereStoragePolicyCompatiblePools", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -3471,7 +3464,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -3482,131 +3475,130 @@ "related": "importVsphereStoragePolicies,listVsphereStoragePolicies", "required": false, "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the IP address of the storage pool", + "name": "ipaddress", "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 storage pool path", - "name": "path", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, - {}, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, + {}, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the scope of the storage pool", + "name": "scope", "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": "the Pod name of the storage pool", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the storage pool type", - "name": "type", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, + {}, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { @@ -3614,26 +3606,20 @@ "name": "suitableformigration", "type": "boolean" }, - {}, { - "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", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" } ] }, @@ -3652,28 +3638,28 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.17.0.0" }, @@ -3682,13 +3668,6 @@ "isasync": false, "name": "updateStoragePool", "params": [ - { - "description": "false to disable the pool for allocation of new volumes, true to enable it back.", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" - }, { "description": "Change the name of the storage pool", "length": 255, @@ -3705,14 +3684,6 @@ "required": false, "type": "long" }, - { - "description": "the Id of the storage pool", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" - }, { "description": "bytes CloudStack can provision from this storage pool", "length": 255, @@ -3726,29 +3697,48 @@ "name": "tags", "required": false, "type": "list" + }, + { + "description": "false to disable the pool for allocation of new volumes, true to enable it back.", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" + }, + { + "description": "the Id of the storage pool", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" } ], "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, - {}, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { @@ -3757,64 +3747,65 @@ "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - {}, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "Storage provider for this pool", + "name": "provider", + "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 Zone name of the storage pool", - "name": "zonename", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "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" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the storage pool path", + "name": "path", "type": "string" }, + {}, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, { "description": "the Pod name of the storage pool", "name": "podname", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { @@ -3823,9 +3814,9 @@ "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { "description": "the storage pool capabilities", @@ -3833,43 +3824,38 @@ "type": "map" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the storage pool path", - "name": "path", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" } ], @@ -3899,51 +3885,34 @@ ], "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ - {}, - { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" - }, - { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" - }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { @@ -3952,58 +3921,59 @@ "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, + {}, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the system VM type", + "name": "systemvmtype", "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 Pod name for the system VM", - "name": "podname", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", + "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { @@ -4012,43 +3982,49 @@ "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the Pod ID for the system VM", + "name": "podid", "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 link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, + {}, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" + }, + { + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" + }, + { + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { @@ -4062,61 +4038,75 @@ "type": "integer" }, { - "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 state of the system VM", - "name": "state", + "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 first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" + }, + { + "description": "the template name for the system VM", + "name": "templatename", "type": "string" } ] }, { - "description": "Import LDAP users", + "description": "Lists Tungsten-Fabric tags", "isasync": false, - "name": "importLdapUsers", + "name": "listTungstenFabricTag", "params": [ { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "List by keyword", "length": 255, - "name": "timezone", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Specifies the domain to which the ldap users are to be imported. If no domain is specified, a domain will created using group parameter. If the group is also not specified, a domain name based on the OU information will be created. If no OU hierarchy exists, will be defaulted to ROOT domain", + "description": "tthe uuid of Tungsten-Fabric nic", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "nicuuid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -4126,57 +4116,57 @@ "type": "integer" }, { - "description": "Creates the account under the specified role.", + "description": "", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "details for account used to store specific parameters", + "description": "the uuid of Tungsten-Fabric vm", "length": 255, - "name": "accountdetails", + "name": "vmuuid", "required": false, - "type": "map" + "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": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "account", + "name": "networkuuid", "required": false, "type": "string" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "accounttype", + "name": "taguuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "keyword", + "name": "policyuuid", "required": false, "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": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "group", + "name": "applicationpolicysetuuid", "required": false, "type": "string" } ], - "related": "searchLdap,listLdapUsers", + "related": "createTungstenFabricTag,applyTungstenFabricTag,removeTungstenFabricTag", "response": [ { "description": "the UUID of the latest async job acting on this object", @@ -4184,24 +4174,20 @@ "type": "string" }, { - "description": "The user's email", - "name": "email", - "type": "string" - }, - { - "description": "The user's lastname", - "name": "lastname", - "type": "string" + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, + {}, { - "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": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, { - "description": "The user's domain", - "name": "domain", - "type": "string" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { "description": "the current status of the latest async job acting on this object", @@ -4209,67 +4195,72 @@ "type": "integer" }, { - "description": "The user's username", - "name": "username", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" + }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, {}, { - "description": "The user's firstname", - "name": "firstname", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, { - "description": "The user's principle", - "name": "principal", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" - }, - {} - ], - "since": "4.3.0" + } + ] }, { - "description": "Lists all available networks.", + "description": "Import LDAP users", "isasync": false, - "name": "listNetworks", + "name": "importLdapUsers", "params": [ { - "description": "the zone ID of the network", + "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": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "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": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.", "length": 255, - "name": "isrecursive", + "name": "group", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list networks supporting certain services", + "description": "List by keyword", "length": 255, - "name": "supportedservices", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "description": "true if need to list only networks which support specifying IP ranges", + "description": "", "length": 255, - "name": "specifyipranges", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List networks by associated networks. Only available if create a Shared network.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "timezone", "required": false, - "since": "4.17.0", - "type": "uuid" + "type": "string" }, { "description": "", @@ -4279,87 +4270,144 @@ "type": "integer" }, { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "description": "Creates the account under the specified role.", "length": 255, - "name": "type", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list networks by ID", + "description": "Specifies the domain to which the ldap users are to be imported. If no domain is specified, a domain will created using group parameter. If the group is also not specified, a domain name based on the OU information will be created. If no OU hierarchy exists, will be defaulted to ROOT domain", "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "list networks by restartRequired", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "restartrequired", + "name": "accounttype", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the network belongs to VPC", + "description": "details for account used to store specific parameters", "length": 255, - "name": "forvpc", + "name": "accountdetails", "required": false, - "type": "boolean" + "type": "map" + } + ], + "related": "searchLdap,listLdapUsers", + "response": [ + { + "description": "The user's firstname", + "name": "firstname", + "type": "string" }, + {}, { - "description": "the ID or VID of the network", - "length": 255, - "name": "vlan", - "required": false, - "since": "4.17.0", + "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": "List networks by VPC", + "description": "The user's username", + "name": "username", + "type": "string" + }, + { + "description": "The user's domain", + "name": "domain", + "type": "string" + }, + { + "description": "The user's principle", + "name": "principal", + "type": "string" + }, + {}, + { + "description": "The user's email", + "name": "email", + "type": "string" + }, + { + "description": "The user's lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.3.0" + }, + { + "description": "Lists all available networks.", + "isasync": false, + "name": "listNetworks", + "params": [ + { + "description": "list networks supporting certain services", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "supportedservices", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "true if need to list only networks which support specifying IP ranges", "length": 255, - "name": "account", + "name": "specifyipranges", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the zone ID of the network", "length": 255, - "name": "tags", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "possible values are \"account\", \"domain\", \"accountdomain\",\"shared\", and \"all\". Default value is \"all\".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by another user. * all : all networks (account, domain and shared).", + "description": "List by keyword", "length": 255, - "name": "networkfilter", + "name": "keyword", "required": false, - "since": "4.17.0", "type": "string" }, { - "description": "true if network is system, false otherwise", + "description": "list networks by restartRequired", "length": 255, - "name": "issystem", + "name": "restartrequired", "required": false, "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list networks available for VM deployment", "length": 255, - "name": "displaynetwork", + "name": "canusefordeploy", "required": false, - "since": "4.4", "type": "boolean" }, + { + "description": "list networks by physical network id", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -4368,6 +4416,14 @@ "required": false, "type": "uuid" }, + { + "description": "List networks by VPC", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, { "description": "type of the traffic", "length": 255, @@ -4383,137 +4439,251 @@ "type": "string" }, { - "description": "list networks by physical network id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "description": "list networks available for VM deployment", + "description": "list networks by network offering ID", "length": 255, - "name": "canusefordeploy", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the network belongs to VPC", "length": 255, - "name": "keyword", + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "page", + "name": "displaynetwork", "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": "true if network is system, false otherwise", "length": 255, - "name": "listall", + "name": "issystem", "required": false, "type": "boolean" }, { - "description": "list networks by network offering ID", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list networks by ID", + "length": 255, + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "flag to display the resource icon for networks", + "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": "showicon", + "name": "networkfilter", "required": false, - "type": "boolean" + "since": "4.17.0", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "page", "required": false, - "type": "uuid" - } - ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "response": [ - {}, + "type": "integer" + }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "flag to display the resource icon for networks", + "length": 255, + "name": "showicon", + "required": false, "type": "boolean" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the ID or VID of the network", + "length": 255, + "name": "vlan", + "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "List networks by associated networks. Only available if create a Shared network.", + "length": 255, + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "since": "4.17.0", + "type": "uuid" + }, + { + "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "length": 255, + "name": "type", + "required": false, + "type": "string" + } + ], + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "response": [ + { + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "list networks that are persistent", + "name": "ispersistent", + "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 name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "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", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "The external id of the network", + "name": "externalid", "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": "acl type - access type to the network", - "name": "acltype", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "list" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "Name of the VPC to which this network belongs", @@ -4521,13 +4691,13 @@ "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the name of the network", + "name": "name", "type": "string" }, { @@ -4541,74 +4711,65 @@ "type": "string" }, { - "description": "the name of the network", - "name": "name", - "type": "string" - }, - { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, - {}, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the first DNS for the network", - "name": "dns1", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, + {}, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "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", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { @@ -4617,33 +4778,28 @@ "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "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", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { @@ -4652,33 +4808,38 @@ "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the type of the network", + "name": "type", "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": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { @@ -4687,107 +4848,50 @@ "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "list" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the list of services", "name": "service", @@ -4796,25 +4900,20 @@ "description": "the service provider name", "name": "provider", "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "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": "uuid of the network provider", @@ -4822,18 +4921,28 @@ "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" } ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", @@ -4855,48 +4964,68 @@ } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "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": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "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": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", + "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 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": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { @@ -4905,29 +5034,54 @@ "type": "long" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - } - ] - }, - { - "description": "List dedicated zones.", - "isasync": false, - "name": "listDedicatedZones", - "params": [ + "description": "the owner of the network", + "name": "account", + "type": "string" + }, { - "description": "", - "length": 255, - "name": "page", + "description": "state of the network", + "name": "state", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + } + ] + }, + { + "description": "List dedicated zones.", + "isasync": false, + "name": "listDedicatedZones", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list dedicated zones by affinity group", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, @@ -4940,10 +5094,10 @@ "type": "uuid" }, { - "description": "the ID of the domain associated with the zone", + "description": "list dedicated zones by affinity group", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, "type": "uuid" }, @@ -4964,41 +5118,37 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], "related": "dedicateZone", "response": [ + {}, { "description": "the ID of the dedicated resource", "name": "id", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "type": "string" }, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, { @@ -5012,7 +5162,11 @@ "name": "zonename", "type": "string" }, - {} + { + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", + "type": "string" + } ] }, { @@ -5030,31 +5184,32 @@ ], "related": "", "response": [ - { - "description": "the state of the storage pool", - "name": "state", - "type": "string" - }, { "description": "the ID of the storage pool", "name": "id", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "default gateway of the pool", - "name": "gateway", + "description": "available iops of the pool", + "name": "maxiops", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "default gateway of the pool", + "name": "gateway", + "type": "string" }, { "description": "the current available space of the pool", @@ -5062,15 +5217,14 @@ "type": "long" }, { - "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": "available iops of the pool", - "name": "maxiops", - "type": "long" + "description": "the state of the storage pool", + "name": "state", + "type": "string" }, { "description": "controller of the pool", @@ -5094,28 +5248,28 @@ } ], "response": [ - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {}, + {} ], "since": "4.17" }, @@ -5125,12 +5279,21 @@ "name": "updatePodManagementNetworkIpRange", "params": [ { - "description": "The new starting IP address.", + "description": "The current ending IP address.", "length": 255, - "name": "newstartip", - "required": false, + "name": "currentendip", + "related": "listPods,updatePod,createManagementNetworkIpRange", + "required": true, "type": "string" }, + { + "description": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, { "description": "The new ending IP address.", "length": 255, @@ -5138,6 +5301,13 @@ "required": false, "type": "string" }, + { + "description": "The new starting IP address.", + "length": 255, + "name": "newstartip", + "required": false, + "type": "string" + }, { "description": "The current starting IP address.", "length": 255, @@ -5145,55 +5315,158 @@ "related": "listPods,updatePod,createManagementNetworkIpRange", "required": true, "type": "string" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", + "description": "the current status of the latest async job acting 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.16.0.0" + }, + { + "description": "list Tungsten-Fabric LB health monitor", + "isasync": false, + "name": "listTungstenFabricLBHealthMonitor", + "params": [ + { + "description": "", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "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" }, { - "description": "The current ending IP address.", + "description": "", "length": 255, - "name": "currentendip", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" } ], + "related": "updateTungstenFabricLBHealthMonitor", "response": [ + { + "description": "the health monitor UUID", + "name": "uuid", + "type": "string" + }, + { + "description": "the health monitor url path", + "name": "urlpath", + "type": "string" + }, + { + "description": "the health monitor http method", + "name": "httpmethod", + "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", "type": "string" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the health monitor retry", + "name": "retry", + "type": "int" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the health monitor type", + "name": "type", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, {}, + { + "description": "the health monitor interval", + "name": "interval", + "type": "int" + }, + { + "description": "the health monitor expected code", + "name": "expectedcode", + "type": "string" + }, + { + "description": "the health monitor timeout", + "name": "timeout", + "type": "int" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } - ], - "since": "4.16.0.0" + ] }, { "description": "Updates firewall rule ", "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, @@ -5202,14 +5475,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, @@ -5221,15 +5486,30 @@ ], "related": "createEgressFirewallRule,createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", "response": [ + { + "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 network id of the firewall rule", "name": "networkid", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" }, { "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", @@ -5237,13 +5517,29 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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": "error code for this icmp message", + "name": "icmpcode", "type": "integer" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + {}, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { @@ -5251,115 +5547,84 @@ "name": "fordisplay", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the 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" }, { - "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": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, + {}, { "description": "the public ip address id for the firewall rule", "name": "ipaddressid", "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - {}, - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" - }, - {} + } ], "since": "4.4" }, @@ -5370,245 +5635,106 @@ "params": [], "related": "", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "is quota service enabled", "name": "isenabled", "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, {} ], "since": "4.7.0" }, { - "description": "lists SRX firewall devices in a physical network", - "isasync": false, - "name": "listSrxFirewalls", + "description": "Deletes account from the project", + "isasync": true, + "name": "deleteAccountFromProject", "params": [ { - "description": "", + "description": "ID of the project to remove the account from", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "List by keyword", + "description": "name of the account to be removed from the project", "length": 255, - "name": "keyword", - "required": false, + "name": "account", + "required": true, "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "SRX firewall device ID", - "length": 255, - "name": "fwdeviceid", - "related": "addSrxFirewall,configureSrxFirewall,listSrxFirewalls", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} + ], + "since": "3.0.0" + }, + { + "description": "List hypervisors", + "isasync": false, + "name": "listHypervisors", + "params": [ + { + "description": "the zone id for listing hypervisors.", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "addSrxFirewall,configureSrxFirewall", + "related": "", "response": [ - {}, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "Hypervisor name", + "name": "name", "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 private interface of the external firewall", - "name": "privateinterface", - "type": "string" - }, - { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "the public security zone of the external firewall", - "name": "publiczone", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", - "type": "string" - }, - { - "description": "the physical network to which this SRX firewall belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the username that's used to log in to the external firewall", - "name": "username", - "type": "string" - }, - { - "description": "device state", - "name": "fwdevicestate", - "type": "string" - }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" - }, - { - "description": "the zone ID of the external firewall", - "name": "zoneid", - "type": "string" - }, - { - "description": "device id of the SRX firewall", - "name": "fwdeviceid", - "type": "string" - }, - { - "description": "device name", - "name": "fwdevicename", - "type": "string" - }, - { - "description": "the private security zone of the external firewall", - "name": "privatezone", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Deletes account from the project", - "isasync": true, - "name": "deleteAccountFromProject", - "params": [ - { - "description": "ID of the project to remove the account from", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, - { - "description": "name of the account to be removed from the project", - "length": 255, - "name": "account", - "required": true, - "type": "string" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } - ], - "since": "3.0.0" - }, - { - "description": "List hypervisors", - "isasync": false, - "name": "listHypervisors", - "params": [ - { - "description": "the zone id for listing hypervisors.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - { - "description": "Hypervisor 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" - }, - {} ] }, { @@ -5641,38 +5767,38 @@ ], "related": "listOsTypes,addGuestOs", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "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 user defined", "name": "isuserdefined", "type": "boolean" }, + {}, { - "description": "the ID of the OS category", - "name": "oscategoryid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the ID of the OS type", "name": "id", "type": "string" }, - {} + { + "description": "the ID of the OS category", + "name": "oscategoryid", + "type": "string" + } ], "since": "4.4.0" }, @@ -5682,54 +5808,54 @@ "name": "listGuestVlans", "params": [ { - "description": "list guest vlan by vnet", + "description": "List by keyword", "length": 255, - "name": "vnet", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list guest vlan by id", + "description": "", "length": 255, - "name": "id", + "name": "page", "required": false, - "type": "long" + "type": "integer" }, { - "description": "", + "description": "list guest vlan by physical network", "length": 255, - "name": "page", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "limits search results to allocated guest vlan. false by default.", "length": 255, - "name": "keyword", + "name": "allocatedonly", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "list guest vlan by id", "length": 255, - "name": "pagesize", + "name": "id", "required": false, - "type": "integer" + "type": "long" }, { - "description": "list guest vlan by physical network", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "limits search results to allocated guest vlan. false by default.", + "description": "list guest vlan by vnet", "length": 255, - "name": "allocatedonly", + "name": "vnet", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list guest vlan by zone", @@ -5743,19 +5869,14 @@ "related": "", "response": [ { - "description": "the project id of the guest VLAN range", - "name": "projectid", + "description": "the zone name of the guest VLAN range", + "name": "zonename", "type": "string" }, { - "description": "the list of networks who use this guest VLAN", - "name": "network", - "type": "list" - }, - { - "description": "date the guest VLAN was taken", - "name": "taken", - "type": "date" + "description": "the account of the guest VLAN range", + "name": "account", + "type": "string" }, { "description": "the guest VLAN", @@ -5763,70 +5884,75 @@ "type": "string" }, { - "description": "the account of the guest VLAN range", - "name": "account", - "type": "string" + "description": "true if the guest VLAN is dedicated to the account", + "name": "isdedicated", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - {}, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the list of networks who use this guest VLAN", + "name": "network", + "type": "list" + }, + { + "description": "the project name of the guest VLAN range", + "name": "project", "type": "string" }, { - "description": "the physical network name of the guest VLAN range", - "name": "physicalnetworkname", + "description": "the allocation state of the guest VLAN", + "name": "allocationstate", "type": "string" }, { - "description": "true if the guest VLAN is dedicated to the account", - "name": "isdedicated", - "type": "boolean" + "description": "the guest VLAN id", + "name": "id", + "type": "long" }, { - "description": "the physical network ID of the guest VLAN range", - "name": "physicalnetworkid", - "type": "string" + "description": "date the guest VLAN was taken", + "name": "taken", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the allocation state of the guest VLAN", - "name": "allocationstate", + "description": "the zone ID of the guest VLAN range", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the project id of the guest VLAN range", + "name": "projectid", "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 ID of the guest VLAN range", - "name": "zoneid", + "description": "the domain ID of the guest VLAN range", + "name": "domainid", "type": "string" }, + {}, { - "description": "the guest VLAN id", - "name": "id", - "type": "long" + "description": "the domain name of the guest VLAN range", + "name": "domain", + "type": "string" }, { - "description": "the zone name of the guest VLAN range", - "name": "zonename", + "description": "the physical network ID of the guest VLAN range", + "name": "physicalnetworkid", "type": "string" } ], @@ -5837,13 +5963,6 @@ "isasync": false, "name": "updateResourceLimit", "params": [ - { - "description": " Maximum resource limit.", - "length": 255, - "name": "max", - "required": false, - "type": "long" - }, { "description": "Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.", "length": 255, @@ -5853,11 +5972,11 @@ "type": "uuid" }, { - "description": "Update resource for a specified account. Must be used with the domainId parameter.", + "description": " Maximum resource limit.", "length": 255, - "name": "account", + "name": "max", "required": false, - "type": "string" + "type": "long" }, { "description": "Update resource limits for project", @@ -5867,6 +5986,13 @@ "required": false, "type": "uuid" }, + { + "description": "Update resource for a specified account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 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, @@ -5877,38 +6003,33 @@ ], "related": "listResourceLimits", "response": [ - { - "description": "the domain name of the resource limit", - "name": "domain", - "type": "string" - }, - { - "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" + "description": "the account of the resource limit", + "name": "account", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the resource limit", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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. 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", @@ -5920,13 +6041,18 @@ "type": "string" }, { - "description": "the account of the resource limit", - "name": "account", + "description": "the project name of the resource limit", + "name": "project", "type": "string" }, { - "description": "the project name of the resource limit", - "name": "project", + "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 domain ID of the resource limit", + "name": "domainid", "type": "string" } ] @@ -5946,27 +6072,27 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -5976,225 +6102,260 @@ "name": "listHostsMetrics", "params": [ { - "description": "the Zone ID for the host", + "description": "the state of the host", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, "type": "uuid" }, { - "description": "the name of 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": "name", + "name": "outofbandmanagementpowerstate", "required": false, "type": "string" }, { - "description": "the host type", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "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 name of the host", "length": 255, - "name": "resourcestate", + "name": "name", "required": false, "type": "string" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "list 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": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "resourcestate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list hosts for which out-of-band management is enabled", + "description": "", "length": 255, - "name": "outofbandmanagementenabled", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the Pod ID for the host", + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "details", "required": false, - "type": "uuid" + "type": "list" }, { "description": "the id of the host", "length": 255, "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "lists hosts existing in particular cluster", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "hypervisor", "required": false, - "type": "uuid" + "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 by keyword", + "description": "the Zone ID for the host", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "hahost", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "page", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the state of the host", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "state", + "name": "outofbandmanagementenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "the host type", "length": 255, - "name": "hypervisor", + "name": "type", "required": false, "type": "string" }, { - "description": "if true, list only hosts dedicated to HA", - "length": 255, - "name": "hahost", - "required": false, - "type": "boolean" - }, - { - "description": "", + "description": "the Pod ID for the host", "length": 255, - "name": "pagesize", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the total cpu used in Ghz", + "name": "cpuusedghz", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "out-of-band management power state", + "name": "powerstate", + "type": "powerstate" + }, { "description": "the resource state of the host", "name": "resourcestate", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { "description": "true if the host has capability to support UEFI boot", "name": "ueficapability", "type": "boolean" }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, { "description": "the number of CPU sockets on the host", "name": "cpusockets", "type": "integer" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", "type": "boolean" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { @@ -6203,103 +6364,100 @@ "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 MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the average cpu load the last minute", - "name": "cpuloadaverage", - "type": "double" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "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": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "network write in GiB", - "name": "networkwrite", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "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": "the host version", - "name": "version", + "description": "the total memory used in GiB", + "name": "memoryusedgb", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the total memory allocated in GiB", + "name": "memoryallocatedgb", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "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": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", "type": "boolean" }, { - "description": "network read in GiB", - "name": "networkread", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { @@ -6308,109 +6466,138 @@ "type": "boolean" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotalgb", + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the cluster ID of the host", "name": "clusterid", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the total memory capacity in GiB", + "name": "memorytotalgb", + "type": "string" }, { - "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": "instances on the host", - "name": "instances", + "description": "network read in GiB", + "name": "networkread", "type": "string" }, { - "description": "out-of-band management power state", - "name": "powerstate", - "type": "powerstate" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocatedghz", "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": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "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": "network write in GiB", + "name": "networkwrite", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the total memory allocated in GiB", - "name": "memoryallocatedgb", - "type": "string" + "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 total cpu capacity in Ghz", + "name": "cputotalghz", + "type": "string" }, { "description": "GPU cards present in the host", "name": "gpugroup", "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, { "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, { "description": "Maximum X resolution per display", "name": "maxresolutionx", @@ -6421,6 +6608,16 @@ "name": "maxvgpuperpgpu", "type": "long" }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, { "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", "name": "remainingcapacity", @@ -6432,8 +6629,8 @@ "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { @@ -6443,123 +6640,102 @@ } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - {}, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the average cpu load the last minute", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "instances on the host", + "name": "instances", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the total cpu used in Ghz", - "name": "cpuusedghz", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the total memory used in GiB", - "name": "memoryusedgb", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotalghz", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" - }, + } + ], + "since": "4.9.3" + }, + { + "description": "get load balancer certificate", + "isasync": false, + "name": "getLoadBalancerSslCertificate", + "params": [ { - "description": "the host type", - "name": "type", - "type": "type" - }, + "description": "the ID of Lb", + "length": 255, + "name": "id", + "related": "getLoadBalancerSslCertificate", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "key", + "name": "key", "type": "string" }, + {}, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocatedghz", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "events available for the host", - "name": "events", + "description": "crt", + "name": "crt", "type": "string" }, + {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "chain", + "name": "chain", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } - ], - "since": "4.9.3" + ] }, { "description": "Release the dedication for the pod", @@ -6581,10 +6757,11 @@ "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", @@ -6593,11 +6770,10 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -6606,48 +6782,34 @@ "name": "listAffinityGroups", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "lists affinity groups by virtual machine ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, "type": "uuid" }, { - "description": "lists affinity groups by name", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "lists affinity groups by virtual machine ID", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "type": "uuid" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -6665,11 +6827,11 @@ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "lists affinity groups by name", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "lists affinity groups by type", @@ -6678,6 +6840,14 @@ "required": false, "type": "string" }, + { + "description": "list the affinity group by the ID provided", + "length": 255, + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -6686,45 +6856,42 @@ "type": "integer" }, { - "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "createAffinityGroup", "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, + {}, { "description": "the domain ID of the affinity group", "name": "domainid", "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 affinity group", + "name": "projectid", + "type": "string" }, - {}, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, + {}, { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { @@ -6732,31 +6899,40 @@ "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the project name of the affinity group", "name": "project", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, - {}, { - "description": "the name of the affinity group", - "name": "name", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the ID of the affinity group", + "name": "id", "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ] }, @@ -6765,13 +6941,6 @@ "isasync": false, "name": "registerSSHKeyPair", "params": [ - { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, @@ -6787,6 +6956,20 @@ "required": false, "type": "uuid" }, + { + "description": "Public key material of the keypair", + "length": 5120, + "name": "publickey", + "required": true, + "type": "string" + }, + { + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", "length": 255, @@ -6794,22 +6977,30 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" - }, - { - "description": "Public key material of the keypair", - "length": 5120, - "name": "publickey", - "required": true, - "type": "string" } ], "related": "listSSHKeyPairs", "response": [ + { + "description": "the project id of the keypair owner", + "name": "projectid", + "type": "string" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + { + "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 owner of the keypair", "name": "account", @@ -6820,12 +7011,6 @@ "name": "name", "type": "string" }, - {}, - { - "description": "the domain name of the keypair owner", - "name": "domain", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -6837,21 +7022,22 @@ "type": "integer" }, { - "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", "type": "string" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" - } + }, + {}, + {} ] }, { @@ -6869,27 +7055,27 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "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" } ] }, @@ -6899,34 +7085,34 @@ "name": "startRollingMaintenance", "params": [ { - "description": "the IDs of the zones to start maintenance on", + "description": "if rolling mechanism should continue in case of an error", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "forced", "required": false, - "type": "list" + "type": "boolean" }, { - "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": "optional operation timeout (in seconds) that overrides the global timeout setting", "length": 255, - "name": "payload", + "name": "timeout", "required": false, - "type": "string" + "type": "integer" }, { - "description": "if rolling mechanism should continue in case of an error", + "description": "the IDs of the hosts to start maintenance on", "length": 255, - "name": "forced", + "name": "hostids", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "required": false, - "type": "boolean" + "type": "list" }, { "description": "the IDs of the pods to start maintenance on", @@ -6937,19 +7123,19 @@ "type": "list" }, { - "description": "the IDs of the hosts to start maintenance on", + "description": "the command to execute while hosts are on maintenance", "length": 255, - "name": "hostids", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", + "name": "payload", "required": false, - "type": "list" + "type": "string" }, { - "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" } ], "related": "", @@ -6958,14 +7144,19 @@ "description": "the hosts updated", "name": "hostsupdated", "response": [ + { + "description": "start date of the update on the host", + "name": "startdate", + "type": "string" + }, { "description": "the name of the updated host", "name": "hostname", "type": "string" }, { - "description": "start date of the update on the host", - "name": "startdate", + "description": "end date of the update on the host", + "name": "enddate", "type": "string" }, { @@ -6977,31 +7168,21 @@ "description": "the ID of the updated host", "name": "hostid", "type": "string" - }, - { - "description": "end date of the update on the host", - "name": "enddate", - "type": "string" } ], "type": "list" }, - {}, { - "description": "indicates if the rolling maintenance operation was successful", - "name": "success", - "type": "boolean" + "description": "in case of failure, details are displayed", + "name": "details", + "type": "string" }, { "description": "the UUID of the latest async job acting on 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 hosts skipped", "name": "hostsskipped", @@ -7025,32 +7206,111 @@ "type": "list" }, { - "description": "in case of failure, details are displayed", - "name": "details", - "type": "string" + "description": "indicates if the rolling maintenance operation was successful", + "name": "success", + "type": "boolean" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { - "description": "Updates network ACL list", - "isasync": true, - "name": "updateNetworkACLList", + "description": "list Tungsten-Fabric application policy set", + "isasync": false, + "name": "listTungstenFabricApplicationPolicySet", "params": [ { - "description": "Name of the network ACL list", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "name", + "name": "applicationpolicysetuuid", "required": false, "type": "string" }, { - "description": "Description of the network ACL list", + "description": "", "length": 255, - "name": "description", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "createTungstenFabricApplicationPolicySet", + "response": [ + { + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "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": "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 tag", + "name": "tag", + "type": "list" + } + ] + }, + { + "description": "Updates network ACL list", + "isasync": true, + "name": "updateNetworkACLList", + "params": [ { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -7059,6 +7319,21 @@ "since": "4.4", "type": "string" }, + { + "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, + "name": "name", + "required": false, + "type": "string" + }, { "description": "an optional field, whether to the display the list to the end user or not", "length": 255, @@ -7068,15 +7343,15 @@ "type": "boolean" }, { - "description": "the ID of the network ACL", + "description": "Description of the network ACL list", "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -7092,13 +7367,12 @@ "name": "success", "type": "boolean" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.4" }, @@ -7115,19 +7389,27 @@ "type": "string" }, { - "description": "the ID of the project to reserve with this IP address", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "fordisplay", "required": false, + "type": "boolean" + }, + { + "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": "an optional field, whether to the display the IP to the end user or not", + "description": "the ID of the project to reserve with this IP address", "length": 255, - "name": "fordisplay", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the ID of the domain to reserve with this IP address", @@ -7136,220 +7418,145 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" - }, - { - "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" } ], "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, - { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" - }, { "description": "the name of the zone the public IP address belongs to", "name": "zonename", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "VPC id the ip belongs to", + "name": "vpcid", "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": "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": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" }, { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", + "description": "is public IP portable across the zones", + "name": "isportable", "type": "boolean" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" - }, - { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the VLAN associated with the IP address", + "name": "vlanname", + "type": "string" }, { - "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinename", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, { "description": "date the public IP address was acquired", "name": "allocated", "type": "date" }, - {}, { - "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachineid", + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", "type": "string" }, + {}, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "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", + "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": "public IP address", - "name": "ipaddress", + "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": "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 where ip belongs to", - "name": "networkname", + "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinename", "type": "string" }, { - "description": "public IP address id", - "name": "id", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" }, { "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", "name": "vmipaddress", "type": "string" }, - {}, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { @@ -7358,23 +7565,90 @@ "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", - "type": "string" + "description": "the list of resource tags associated with ip address", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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": "list" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachineid", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", "type": "string" } ], @@ -7389,7 +7663,7 @@ "description": "Virtual Machine ID", "length": 255, "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "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,importUnmanagedInstance", "required": true, "type": "uuid" }, @@ -7397,401 +7671,518 @@ "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", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, "type": "uuid" } ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "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,importUnmanagedInstance", "response": [ { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "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 state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "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": "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": "OS name of the vm", + "name": "osdisplayname", "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 date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "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 name of the domain in which the virtual machine exists", - "name": "domain", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "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 ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the group name of the virtual machine", + "name": "group", "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" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "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 ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the affinity group", - "name": "id", - "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the 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": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "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 user's ID who deployed the virtual machine", - "name": "userid", - "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 received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the security group", "name": "domain", "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" } ], "type": "set" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "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" }, { @@ -7799,44 +8190,44 @@ "name": "nic", "response": [ { - "description": "the traffic type of the nic", - "name": "traffictype", + "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the type of the nic", + "name": "type", "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 IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", @@ -7844,33 +8235,33 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -7879,13 +8270,8 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -7894,454 +8280,307 @@ "type": "list" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Type of adapter if available", + "name": "adaptertype", "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 isolation uri of the nic", - "name": "isolationuri", + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "name": "macaddress", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" } ], "type": "set" }, - {}, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "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 account associated with the virtual machine", - "name": "account", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "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 updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "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", - "name": "id", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the security group", + "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 type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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": "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" - }, - { - "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 domain ID of the affinity 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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + } + ], + "type": "set" + }, + { + "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": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - } - ], - "type": "set" + "description": "tag value", + "name": "value", + "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 project id of the group", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" } ], "type": "set" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the ID of the 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": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { @@ -8349,22 +8588,102 @@ "name": "templatename", "type": "string" }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + {}, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "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", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "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 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": "device ID of the root volume", + "name": "rootdeviceid", + "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" - }, - {} + } ], "since": "3.0.0" }, @@ -8374,11 +8693,11 @@ "name": "deleteEvents", "params": [ { - "description": "delete by event type", + "description": "start date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "type", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { "description": "the IDs of the events", @@ -8389,18 +8708,18 @@ "type": "list" }, { - "description": "start date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "startdate", + "name": "enddate", "required": false, "type": "date" }, { - "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "delete by event type", "length": 255, - "name": "enddate", + "name": "type", "required": false, - "type": "date" + "type": "string" } ], "response": [ @@ -8409,13 +8728,6 @@ "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", @@ -8425,6 +8737,13 @@ "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" } ] }, @@ -8448,18 +8767,18 @@ "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", @@ -8482,9 +8801,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", @@ -8493,14 +8812,14 @@ }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {} ] @@ -8511,26 +8830,19 @@ "name": "listUcsBlades", "params": [ { - "description": "ucs manager id", - "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", - "required": true, - "type": "uuid" - }, - { - "description": "", + "description": "", "length": 255, "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "ucs manager id", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, + "type": "uuid" }, { "description": "List by keyword", @@ -8538,30 +8850,41 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "associateUcsProfileToBlade", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ucs blade id", + "name": "id", "type": "string" }, - {}, { - "description": "ucs blade dn", - "name": "bladedn", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "cloudstack host id this blade associates to", "name": "hostid", "type": "string" }, + {}, { - "description": "ucs blade id", - "name": "id", + "description": "ucs blade dn", + "name": "bladedn", + "type": "string" + }, + { + "description": "ucs manager id", + "name": "ucsmanagerid", "type": "string" }, { @@ -8570,15 +8893,11 @@ "type": "string" }, { - "description": "ucs manager id", - "name": "ucsmanagerid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { @@ -8601,18 +8920,18 @@ "name": "jobid", "type": "string" }, + {}, { "description": "Volume iSCSI Name", "name": "volumeiScsiName", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - {} + } ] }, { @@ -8624,7 +8943,7 @@ "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", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": true, "type": "uuid" }, @@ -8638,66 +8957,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": "Deletes an external firewall appliance.", - "isasync": false, - "name": "deleteExternalFirewall", - "params": [ - { - "description": "Id of the external firewall appliance.", - "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -8706,6 +8986,14 @@ "isasync": false, "name": "updateHost", "params": [ + { + "description": "Change the name of host", + "length": 255, + "name": "name", + "required": false, + "since": "4.15", + "type": "string" + }, { "description": "Add an annotation to this host", "length": 255, @@ -8714,6 +9002,21 @@ "since": "4.11", "type": "string" }, + { + "description": "the new uri for the secondary storage: nfs://host/path", + "length": 255, + "name": "url", + "required": false, + "type": "string" + }, + { + "description": "the ID of the host to update", + "length": 255, + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "required": true, + "type": "uuid" + }, { "description": "the id of Os category to update the host with", "length": 255, @@ -8735,76 +9038,63 @@ "name": "hosttags", "required": false, "type": "list" - }, + } + ], + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "response": [ { - "description": "the ID of the host to update", - "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", - "required": true, - "type": "uuid" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the new uri for the secondary storage: nfs://host/path", - "length": 255, - "name": "url", - "required": false, + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "Change the name of host", - "length": 255, - "name": "name", - "required": false, - "since": "4.15", - "type": "string" - } - ], - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "response": [ - { - "description": "events available for the host", - "name": "events", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "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 CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the ID of the host", - "name": "id", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the host 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 management server ID of the host", + "name": "managementserverid", "type": "string" }, { @@ -8815,16 +9105,6 @@ "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", @@ -8835,16 +9115,16 @@ "name": "maxresolutiony", "type": "long" }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, { "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", "name": "remainingcapacity", "type": "long" }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, { "description": "Maximum displays per user", "name": "maxheads", @@ -8854,6 +9134,16 @@ "description": "Maximum no. of vgpu per gpu card (pgpu)", "name": "maxvgpuperpgpu", "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" } ], "type": "list" @@ -8867,166 +9157,150 @@ "type": "list" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, { "description": "the date and time the host was last pinged", "name": "lastpinged", "type": "date" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, - { - "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 host out-of-band management information", "name": "outofbandmanagement", "type": "outofbandmanagementresponse" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the host version", - "name": "version", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "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 amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "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 memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, - {}, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, + {}, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { "description": "the state of the host", @@ -9039,39 +9313,30 @@ "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the ID of the host", + "name": "id", "type": "string" }, + {}, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the Zone name of the host", - "name": "zonename", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "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" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the hypervisor version", + "name": "hypervisorversion", "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 amount of the host's CPU currently allocated in MHz", @@ -9079,9 +9344,14 @@ "type": "long" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { "description": "the outgoing network traffic on the host", @@ -9089,39 +9359,54 @@ "type": "long" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "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 amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" } ] }, @@ -9131,25 +9416,12 @@ "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": "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.", + "description": "the network id of the port forwarding rule", "length": 255, - "name": "protocol", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, - "type": "string" + "type": "uuid" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -9160,18 +9432,32 @@ "type": "boolean" }, { - "description": "the starting port of firewall rule", + "description": "the ending port of firewall rule", "length": 255, - "name": "startport", + "name": "endport", "required": false, "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "type of firewallrule: system/user", "length": 255, - "name": "destcidrlist", + "name": "type", "required": false, - "type": "list" + "type": "string" + }, + { + "description": "the starting port of firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" + }, + { + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" }, { "description": "type of the icmp message being sent", @@ -9181,72 +9467,66 @@ "type": "integer" }, { - "description": "the network id of the port forwarding rule", + "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "destcidrlist", + "required": false, + "type": "list" }, { - "description": "the ending port of firewall rule", + "description": "error code for this icmp message", "length": 255, - "name": "endport", + "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "type of firewallrule: system/user", + "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "type", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" } ], "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", "name": "destcidrlist", "type": "string" }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, {}, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "the ending port of firewall rule's port range", + "name": "endport", "type": "integer" }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - {}, { "description": "the network id of the firewall rule", "name": "networkid", "type": "string" }, { - "description": "the ID of the firewall 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": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the state of the rule", "name": "state", @@ -9258,13 +9538,13 @@ "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { @@ -9272,23 +9552,23 @@ "name": "tags", "response": [ { - "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -9297,8 +9577,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -9307,31 +9587,26 @@ "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" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { @@ -9340,9 +9615,19 @@ "type": "integer" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" } ] }, @@ -9352,91 +9637,162 @@ "name": "listVPCOfferings", "params": [ { - "description": "list VPC offerings by state", + "description": "id of zone VPC offering is associated with", "length": 255, - "name": "state", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "since": "4.13", + "type": "uuid" }, { - "description": "true if need to list only default VPC offerings. Default value is false", + "description": "list VPC offerings by id", "length": 255, - "name": "isdefault", + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "list VPC offerings by state", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "list VPC offerings supporting certain services", "length": 255, - "name": "keyword", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "id of zone disk offering is associated with", + "description": "list VPC offerings available for VPC creation in specific domain", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "since": "4.13", + "since": "4.18", "type": "uuid" }, { - "description": "list VPC offerings by id", + "description": "", "length": 255, - "name": "id", - "related": "updateVPCOffering,listVPCOfferings", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list VPC offerings by display text", + "description": "", "length": 255, - "name": "displaytext", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list VPC offerings by name", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "list VPC offerings supporting certain services", + "description": "true if need to list only default VPC offerings. Default value is false", "length": 255, - "name": "supportedservices", + "name": "isdefault", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "list VPC offerings by name", + "description": "list VPC offerings by display text", "length": 255, - "name": "name", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "updateVPCOffering", "response": [ + { + "description": "the id of the vpc offering", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + {}, + {}, + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domain", "type": "string" }, + { + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, + { + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" + }, { "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", @@ -9445,11 +9801,6 @@ "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", @@ -9459,22 +9810,27 @@ "description": "the capability value", "name": "value", "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" } ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "state of the network provider", - "name": "state", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -9483,14 +9839,14 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { "description": "the destination physical network", @@ -9498,87 +9854,25 @@ "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" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, - { - "description": "the id of the vpc offering", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, { "description": "an alternate display text of the vpc offering.", "name": "displaytext", "type": "string" - }, - {}, - { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" - }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "type": "string" } ] }, @@ -9598,21 +9892,21 @@ "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": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", + "name": "solidFireVolumeSize", + "type": "long" } ] }, @@ -9622,11 +9916,11 @@ "name": "uploadVolume", "params": [ { - "description": "the ID of the zone the volume is to be hosted on", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, "type": "uuid" }, { @@ -9638,25 +9932,11 @@ "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" - }, - { - "description": "the checksum value of this volume. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, - "type": "string" - }, - { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, "type": "uuid" }, { @@ -9667,9 +9947,16 @@ "type": "string" }, { - "description": "the name of the volume", + "description": "Image store uuid", "length": 255, - "name": "name", + "name": "imagestoreuuid", + "required": false, + "type": "string" + }, + { + "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", "required": true, "type": "string" }, @@ -9682,268 +9969,210 @@ "type": "uuid" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "the checksum value of this volume. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "account", + "name": "checksum", "required": false, "type": "string" }, { - "description": "Image store uuid", + "description": "the name of the volume", "length": 255, - "name": "imagestoreuuid", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "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", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, { "description": "the display text of the disk offering", "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": " 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": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - {}, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - {}, - { - "description": "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": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, + {}, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" - }, - { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, + {}, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "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 domain associated with the disk volume", - "name": "domain", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "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 availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the path of the volume", + "name": "path", "type": "string" }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, { "description": "the state of the disk volume", "name": "state", "type": "string" }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "the project id the tag belongs to", "name": "projectid", @@ -9955,18 +10184,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -9980,26 +10209,61 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" } ], "type": "set" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "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": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { @@ -10008,29 +10272,59 @@ "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "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 date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { "description": "the disk utilization", @@ -10038,54 +10332,59 @@ "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" } ] }, @@ -10095,77 +10394,76 @@ "name": "listSecurityGroups", "params": [ { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "lists security groups by name", "length": 255, - "name": "listall", + "name": "securitygroupname", "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 tags (key/value pairs)", "length": 255, - "name": "isrecursive", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "list the security group by the id provided", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "lists security groups by name", + "description": "", "length": 255, - "name": "securitygroupname", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by 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 resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "lists 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,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { "description": "list only resources belonging to the domain specified", @@ -10176,42 +10474,38 @@ "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,importUnmanagedInstance", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createSecurityGroup,updateSecurityGroup", "response": [ { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "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", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -10224,109 +10518,103 @@ "name": "account", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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": "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 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": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "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": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], "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 domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "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" }, { @@ -10340,8 +10628,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -10350,68 +10638,59 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, - {}, { - "description": "the project name of the group", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -10421,19 +10700,14 @@ "name": "project", "type": "string" }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -10442,13 +10716,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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" }, { @@ -10457,29 +10731,69 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -10488,39 +10802,24 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the security group", + "name": "name", "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 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 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 domain ID of the security group", - "name": "domainid", - "type": "string" } ] }, @@ -10530,12 +10829,11 @@ "name": "configureOutOfBandManagement", "params": [ { - "description": "the ID of the host", + "description": "the host management interface password", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { "description": "the host management interface user", @@ -10545,66 +10843,66 @@ "type": "string" }, { - "description": "the host management interface port", + "description": "the ID of the host", "length": 255, - "name": "port", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the host management interface password", + "description": "the host management interface driver, for example: ipmitool", "length": 255, - "name": "password", + "name": "driver", "required": true, "type": "string" }, { - "description": "the host management interface driver, for example: ipmitool", + "description": "the host management interface IP address", "length": 255, - "name": "driver", + "name": "address", "required": true, "type": "string" }, { - "description": "the host management interface IP address", + "description": "the host management interface port", "length": 255, - "name": "address", + "name": "port", "required": true, "type": "string" } ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,disableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ - {}, { "description": "the operation result description", "name": "description", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "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 interface username", + "name": "username", "type": "string" }, { @@ -10613,33 +10911,34 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the out-of-band management driver for the host", + "name": "driver", + "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" } ], @@ -10674,16 +10973,16 @@ ], "related": "", "response": [ - { - "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", "type": "string" }, + { + "description": "the pool ID of the storage tag", + "name": "poolid", + "type": "long" + }, {}, { "description": "the name of the storage tag", @@ -10691,15 +10990,15 @@ "type": "string" }, {}, + { + "description": "the ID of the storage tag", + "name": "id", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the pool ID of the storage tag", - "name": "poolid", - "type": "long" } ] }, @@ -10718,9 +11017,10 @@ } ], "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" }, { @@ -10735,11 +11035,10 @@ "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" - }, - {} + } ] }, { @@ -10758,15 +11057,11 @@ ], "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", "response": [ - { - "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 ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { @@ -10779,15 +11074,19 @@ "name": "id", "type": "string" }, + { + "description": "the list of projects the template is available for", + "name": "projectids", + "type": "list" + }, { "description": "the list of accounts the template is available for", "name": "account", "type": "list" }, - {}, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -10798,151 +11097,160 @@ ] }, { - "description": "Destroyes 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": "optional: the id of the user of the annotation", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "name": "userid", + "required": false, + "since": "4.16.0", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, - {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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 gateway for the system VM", - "name": "gateway", + "description": "the entity type", + "length": 255, + "name": "entitytype", + "required": false, "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the system VM", + "description": "the id of the annotation", + "length": 255, "name": "id", + "required": false, "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the id of the entity for which to show annotations", + "length": 255, + "name": "entityid", + "required": false, "type": "string" - }, + } + ], + "related": "addAnnotation,removeAnnotation,updateAnnotationVisibility", + "response": [ { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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 state of the system VM", - "name": "state", + "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 (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" }, {}, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "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 (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, + {}, { - "description": "the systemvm agent version", - "name": "version", + "description": "The username of the user that entered the annotation", + "name": "username", "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 the entity/resource has annotations", - "name": "hasannotations", + "description": "True if the annotation is available for admins only", + "name": "adminsonly", "type": "boolean" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" - }, + } + ], + "since": "4.11" + }, + { + "description": "Destroys a system virtual machine.", + "isasync": true, + "name": "destroySystemVm", + "params": [ { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" - }, + "description": "The ID of the system virtual machine", + "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 Zone name for the system VM", - "name": "zonename", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { @@ -10951,197 +11259,193 @@ "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "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 public IP address for the system VM", - "name": "publicip", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the ID of the system VM", + "name": "id", "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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", - "type": "integer" + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the gateway for the system VM", + "name": "gateway", "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": "Lists annotations.", - "isasync": false, - "name": "listAnnotations", - "params": [ + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" }, { - "description": "the entity type", - "length": 255, - "name": "entitytype", - "required": false, + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the id of the annotation", - "length": 255, - "name": "id", - "required": false, + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "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 first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "optional: the id of the user of the annotation", - "length": 255, - "name": "userid", - "required": false, - "since": "4.16.0", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the id of the entity for which to show annotations", - "length": 255, - "name": "entityid", - "required": false, + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "addAnnotation,removeAnnotation,updateAnnotationVisibility", - "response": [ + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, { - "description": "the creation timestamp for this annotation", + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" + }, + { + "description": "the date and time the system VM was created", "name": "created", "type": "date" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the (uu)id of the entitiy to which this annotation pertains", - "name": "entityid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, - {}, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, - {}, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, + {}, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the name of the entitiy to which this annotation pertains", - "name": "entityname", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" } - ], - "since": "4.11" + ] }, { "description": "Adds Swift.", @@ -11149,10 +11453,10 @@ "name": "addSwift", "params": [ { - "description": "the username for swift", + "description": "the URL for swift", "length": 255, - "name": "username", - "required": false, + "name": "url", + "required": true, "type": "string" }, { @@ -11170,39 +11474,33 @@ "type": "string" }, { - "description": "the URL for swift", + "description": "the username for swift", "length": 255, - "name": "url", - "required": true, + "name": "username", + "required": false, "type": "string" } ], "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "response": [ { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, { - "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 protocol of the image store", - "name": "protocol", + "description": "the name of the image store", + "name": "name", "type": "string" }, { @@ -11216,15 +11514,25 @@ "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", "type": "string" }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the Zone name of the image store", "name": "zonename", @@ -11232,24 +11540,20 @@ }, {}, { - "description": "the name of the image store", - "name": "name", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the provider name of the image store", - "name": "providername", + "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" } ], "since": "3.0.0" @@ -11259,14 +11563,6 @@ "isasync": false, "name": "archiveEvents", "params": [ - { - "description": "the IDs of the events", - "length": 255, - "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, @@ -11281,6 +11577,14 @@ "required": false, "type": "string" }, + { + "description": "the IDs of the events", + "length": 255, + "name": "ids", + "related": "listEvents", + "required": false, + "type": "list" + }, { "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, @@ -11291,27 +11595,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": "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" - } + {} ] }, { @@ -11329,174 +11633,185 @@ } ], "response": [ - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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.2.0" }, { - "description": "Adds a SRX firewall device", - "isasync": true, - "name": "addSrxFirewall", + "description": "List registered userdatas", + "isasync": false, + "name": "listUserData", "params": [ { - "description": "the 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,listPhysicalNetworks,updatePhysicalNetwork", - "required": true, - "type": "uuid" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "Credentials to reach SRX firewall device", + "description": "Userdata name to look for", "length": 255, - "name": "password", - "required": true, + "name": "name", + "required": false, "type": "string" }, { - "description": "supports only JuniperSRXFirewall", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "networkdevicetype", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" }, { - "description": "Credentials to reach SRX firewall device", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "URL of the SRX appliance.", + "description": "", "length": 255, - "name": "url", - "required": true, - "type": "string" - } - ], - "related": "configureSrxFirewall", - "response": [ - { - "description": "the username that's used to log in to the external firewall", - "name": "username", - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "device name", - "name": "fwdevicename", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, - {}, { - "description": "name of the provider", - "name": "provider", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, + "description": "the ID of the Userdata", + "length": 255, + "name": "id", + "related": "listUserData", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the domain id of the userdata owner", + "name": "domainid", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "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 management IP address of the external firewall", - "name": "ipaddress", + "description": "the owner id of the userdata", + "name": "accountid", "type": "string" }, { - "description": "the physical network to which this SRX firewall belongs to", - "name": "physicalnetworkid", + "description": "the owner of the userdata", + "name": "account", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the domain name of the userdata owner", + "name": "domain", "type": "string" }, + {}, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "base64 encoded userdata content", + "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" - }, - { - "description": "device id of the SRX firewall", - "name": "fwdeviceid", + "description": "Name of the userdata", + "name": "name", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } - ] + ], + "since": "4.18" }, { "description": "Updates an internal load balancer", "isasync": true, "name": "updateLoadBalancer", "params": [ + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -11509,129 +11824,88 @@ "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" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" } ], "related": "createLoadBalancer,listLoadBalancers", "response": [ { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - }, - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - } - ], - "type": "list" + "description": "the domain of the Load Balancer", + "name": "domain", + "type": "string" }, { - "description": "the Load Balancer ID", - "name": "id", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, - {}, { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", + "description": "the project name of the Load Balancer", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" + }, + { + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project id of the Load Balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the instance", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the state of the instance", + "name": "state", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "the project name of the Load Balancer", - "name": "project", - "type": "string" - }, - { - "description": "the description of the Load Balancer", - "name": "description", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "Load Balancer source ip", + "name": "sourceipaddress", "type": "string" }, { @@ -11639,74 +11913,107 @@ "name": "name", "type": "string" }, - { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" - }, { "description": "Load Balancer network id", "name": "networkid", "type": "string" }, { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", + "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 list of resource tags associated with the Load Balancer", + "name": "tags", "response": [ { - "description": "the instance ID", - "name": "id", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the name of the instance", - "name": "name", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the state of the instance", - "name": "state", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ip address of the instance", - "name": "ipaddress", + "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": "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" } ], "type": "list" }, - { - "description": "the domain of the Load Balancer", - "name": "domain", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" - }, - { - "description": "Load Balancer source ip", - "name": "sourceipaddress", - "type": "string" - }, - { - "description": "the project id of the Load Balancer", - "name": "projectid", - "type": "string" - }, + {}, { "description": "the load balancer algorithm (source, roundrobin, leastconn)", "name": "algorithm", "type": "string" }, - {} + { + "description": "the 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" + } ], "since": "4.4.0" }, @@ -11715,13 +12022,6 @@ "isasync": true, "name": "scaleSystemVm", "params": [ - { - "description": "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, { "description": "the service offering ID to apply to the system vm", "length": 255, @@ -11730,6 +12030,13 @@ "required": true, "type": "uuid" }, + { + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, { "description": "The ID of the system vm", "length": 255, @@ -11742,59 +12049,59 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the Zone ID for the system VM", + "name": "zoneid", "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": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", + "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the link local MAC address for the system vm", @@ -11802,29 +12109,24 @@ "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" - }, - { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the first DNS for the system VM", + "name": "dns1", "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 link local netmask for the system vm", @@ -11832,33 +12134,33 @@ "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "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 private netmask for the system VM", - "name": "privatenetmask", + "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", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { @@ -11867,60 +12169,53 @@ "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - {}, - { - "description": "the state of the system VM", - "name": "state", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the state of the system VM", + "name": "state", "type": "string" }, - {}, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { @@ -11929,13 +12224,30 @@ "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" + }, + {}, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + {}, + { + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" + }, + { + "description": "the ID of the system VM", + "name": "id", "type": "string" } ] @@ -11945,14 +12257,6 @@ "isasync": false, "name": "listSnapshotPolicies", "params": [ - { - "description": "the ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "type": "uuid" - }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, @@ -11968,6 +12272,13 @@ "required": false, "type": "integer" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "List by keyword", "length": 255, @@ -11976,152 +12287,175 @@ "type": "string" }, { - "description": "the ID of the snapshot policy", + "description": "the ID of the disk volume", "length": 255, - "name": "id", - "related": "createSnapshotPolicy,updateSnapshotPolicy,listSnapshotPolicies", + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of the snapshot policy", "length": 255, - "name": "page", + "name": "id", + "related": "createSnapshotPolicy,updateSnapshotPolicy,listSnapshotPolicies", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createSnapshotPolicy,updateSnapshotPolicy", "response": [ + { + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" + }, + { + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, + { + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" + }, + { + "description": "is this policy for display to the regular user", + "name": "fordisplay", "type": "boolean" }, {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "the ID of the snapshot policy", + "name": "id", + "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {} + ] + }, + { + "description": "Update site to site vpn customer gateway", + "isasync": true, + "name": "updateVpnCustomerGateway", + "params": [ { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "length": 255, + "name": "esplifetime", + "required": false, + "type": "long" + }, + { + "description": "ESP policy of the customer gateway", + "length": 255, + "name": "esppolicy", + "required": true, "type": "string" }, { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "public ip address id of the customer gateway", + "length": 255, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" - }, - { - "description": "the ID of the snapshot policy", - "name": "id", - "type": "string" - }, - { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, - { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - } - ] - }, - { - "description": "Update site to site vpn customer gateway", - "isasync": true, - "name": "updateVpnCustomerGateway", - "params": [ - { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "esplifetime", - "required": false, - "type": "long" + "name": "ipsecpsk", + "required": true, + "type": "string" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "ikelifetime", + "name": "splitconnections", "required": false, - "type": "long" + "since": "4.15.1", + "type": "boolean" }, { "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", @@ -12131,11 +12465,11 @@ "type": "string" }, { - "description": "public ip address id of the customer gateway", + "description": "Force encapsulation for Nat Traversal", "length": 255, - "name": "gateway", - "required": true, - "type": "string" + "name": "forceencap", + "required": false, + "type": "boolean" }, { "description": "id of customer gateway", @@ -12146,18 +12480,12 @@ "type": "uuid" }, { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", - "length": 255, - "name": "ipsecpsk", - "required": true, - "type": "string" - }, - { - "description": "name of this customer gateway", + "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": "name", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the account associated with the gateway. Must be used with the domainId parameter.", @@ -12167,42 +12495,26 @@ "type": "string" }, { - "description": "If DPD is enabled for VPN connection", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "dpd", + "name": "ikelifetime", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "Force encapsulation for Nat Traversal", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "forceencap", + "name": "dpd", "required": false, "type": "boolean" }, { - "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "description": "ESP policy of the customer gateway", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "esppolicy", + "name": "ikepolicy", "required": true, "type": "string" }, - { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "length": 255, - "name": "splitconnections", - "required": false, - "since": "4.15.1", - "type": "boolean" - }, { "description": "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, @@ -12212,100 +12524,90 @@ "type": "string" }, { - "description": "IKE policy of the customer gateway", + "description": "name of this customer gateway", "length": 255, - "name": "ikepolicy", - "required": true, + "name": "name", + "required": false, "type": "string" } ], "related": "createVpnCustomerGateway,listVpnCustomerGateways", "response": [ - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, { "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", "name": "ikeversion", "type": "string" }, { - "description": "the project name", - "name": "project", - "type": "string" - }, - { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "name": "splitconnections", "type": "boolean" }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, { "description": "the owner", "name": "account", "type": "string" }, { - "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": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the project id", + "name": "projectid", "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", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "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": "name of the customer gateway", + "name": "name", + "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { @@ -12314,25 +12616,35 @@ "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { "description": "if DPD is enabled for customer gateway", "name": "dpd", "type": "boolean" }, + { + "description": "IPsec policy of customer gateway", + "name": "esppolicy", + "type": "string" + }, + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", + "type": "string" + }, { "description": "the date and time the host was removed", "name": "removed", @@ -12341,178 +12653,149 @@ ] }, { - "description": "This deprecated function used to locks an account. Look for the API DisableAccount instead", - "isasync": false, - "name": "lockAccount", + "description": "apply Tungsten-Fabric tag", + "isasync": true, + "name": "applyTungstenFabricTag", "params": [ { - "description": "Locks the specified account on this domain.", + "description": "the uuid of networks", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, - "type": "uuid" + "name": "networkuuid", + "required": false, + "type": "list" }, { - "description": "Locks the specified account.", + "description": "the uuid of nics", "length": 255, - "name": "account", - "required": true, - "type": "string" - } - ], - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "response": [ - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the list of acl groups that account belongs to", - "name": "groups", + "name": "nicuuid", + "required": false, "type": "list" }, - {}, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the uuid of vms", + "length": 255, + "name": "vmuuid", + "required": false, + "type": "list" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the uuid of Tungsten-Fabric tag", + "length": 255, + "name": "taguuid", + "required": true, "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": false, "type": "string" - }, + } + ], + "related": "createTungstenFabricTag,removeTungstenFabricTag", + "response": [ { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, + {}, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" }, { - "description": "the name of the account", - "name": "name", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {} + ] + }, + { + "description": "This deprecated function used to locks an account. Look for the API DisableAccount instead", + "isasync": false, + "name": "lockAccount", + "params": [ { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "Locks the specified account.", + "length": 255, + "name": "account", + "required": true, + "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, + "description": "Locks the specified account on this domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": true, + "type": "uuid" + } + ], + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "response": [ { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the state of the account", + "name": "state", + "type": "string" }, { "description": "details for the account", @@ -12520,64 +12803,28 @@ "type": "map" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - }, - {}, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the name of the account", + "name": "name", "type": "string" }, { @@ -12586,38 +12833,13 @@ "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "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) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -12625,8 +12847,33 @@ "name": "user", "response": [ { - "description": "the user lastname", - "name": "lastname", + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { @@ -12635,9 +12882,9 @@ "type": "resourceiconresponse" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { "description": "the account name of the user", @@ -12645,43 +12892,48 @@ "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "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 user state", + "name": "state", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the user name", - "name": "username", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { @@ -12690,61 +12942,111 @@ "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the user email address", - "name": "email", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the type of the role", - "name": "roletype", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the user state", - "name": "state", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user lastname", + "name": "lastname", "type": "string" } ], "type": "list" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "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": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { @@ -12753,9 +13055,14 @@ "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { "description": "the name of the role", @@ -12763,24 +13070,151 @@ "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, + {}, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "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 total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, { "description": "the ID of the role", "name": "roleid", "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + {}, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" } ] }, @@ -12807,39 +13241,85 @@ ], "related": "destroyRouter,listRouters,rebootRouter,startRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ + {}, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "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 version of template", + "name": "version", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, { "description": "the public netmask for the router", "name": "publicnetmask", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the gateway for the router", + "name": "gateway", "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": "result of the health check", + "name": "success", + "type": "boolean" }, { "description": "the name of the health check on the router", @@ -12847,31 +13327,36 @@ "type": "string" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" } ], "type": "list" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the name of the router", + "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 VPC the router belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { @@ -12880,18 +13365,18 @@ "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 ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -12900,84 +13385,103 @@ "type": "date" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, - {}, { - "description": "the version of template", - "name": "version", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { @@ -12986,8 +13490,13 @@ "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -12996,13 +13505,18 @@ "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the Zone name for the router", + "name": "zonename", "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 version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -13010,48 +13524,43 @@ "name": "nic", "response": [ { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -13060,14 +13569,9 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { "description": "true if nic is default, false otherwise", @@ -13075,28 +13579,43 @@ "type": "boolean" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the nic", + "name": "id", "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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" }, { @@ -13105,38 +13624,38 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -13145,107 +13664,32 @@ "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" } ], "type": "set" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the hostname for the router", - "name": "hostname", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, - {}, { "description": "the network domain for the router", "name": "networkdomain", "type": "string" }, + {}, { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "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", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" } ] @@ -13256,42 +13700,27 @@ "name": "listClusters", "params": [ { - "description": "lists clusters by allocation state", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "allocationstate", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "lists clusters by Zone ID", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists clusters by Pod ID", + "description": "lists clusters by Zone ID", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, - { - "description": "flag to display the capacity of the clusters", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" - }, - { - "description": "whether this cluster is managed by cloudstack", - "length": 255, - "name": "managedstate", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -13308,78 +13737,169 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "lists clusters by cluster type", "length": 255, - "name": "keyword", + "name": "clustertype", "required": false, "type": "string" }, { - "description": "", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "page", + "name": "showcapacities", "required": false, - "type": "integer" + "type": "boolean" }, { - "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 cluster type", + "description": "lists clusters by allocation state", "length": 255, - "name": "clustertype", + "name": "allocationstate", "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "lists clusters by the cluster name", "length": 255, "name": "name", "required": false, "type": "string" + }, + { + "description": "lists clusters by Pod ID", + "length": 255, + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" } ], "related": "addCluster,updateCluster", "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 memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "the cluster ID", + "name": "id", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + { + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" + }, + { + "description": "the 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 cluster name", "name": "name", "type": "string" }, + { + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" + }, + {}, + { + "description": "the Zone name of the cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + {}, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, { "description": "the capacity name", "name": "name", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, { "description": "the Zone ID", "name": "zoneid", @@ -13391,113 +13911,37 @@ "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the Pod name", - "name": "podname", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" } ], "type": "list" - }, - { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" - }, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - { - "description": "the cluster ID", - "name": "id", - "type": "string" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -13516,28 +13960,28 @@ } ], "response": [ + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "3.0.0" }, @@ -13547,34 +13991,26 @@ "name": "listProjectInvitations", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "list invitation by user ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" }, { - "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", - "length": 255, - "name": "activeonly", - "required": false, - "type": "boolean" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 invitations by id", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "listProjectInvitations", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -13584,19 +14020,19 @@ "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list invitations by id", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "listProjectInvitations", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list by project id", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list invitations by state", @@ -13606,11 +14042,11 @@ "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", "length": 255, - "name": "account", + "name": "activeonly", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -13620,102 +14056,187 @@ "type": "integer" }, { - "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": "list invitation by user ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list by project id", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" } ], "related": "", "response": [ - { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the email the invitation was sent to", - "name": "email", + "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 name of the project", + "name": "project", "type": "string" }, { - "description": "the account name of the project's owner", - "name": "account", + "description": "the User ID", + "name": "userid", "type": "string" }, - {}, { - "description": "the id of the project", - "name": "projectid", + "description": "the invitation state", + "name": "state", "type": "string" }, { - "description": "the User ID", - "name": "userid", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the account name of the project's owner", + "name": "account", "type": "string" }, { - "description": "the name of the project", - "name": "project", + "description": "the id of the project", + "name": "projectid", "type": "string" }, + {}, { - "description": "the invitation state", - "name": "state", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { "description": "the id of the invitation", "name": "id", "type": "string" + }, + {}, + { + "description": "the email the invitation was sent to", + "name": "email", + "type": "string" } ], "since": "3.0.0" }, + { + "description": "create Tungsten-Fabric firewall policy", + "isasync": true, + "name": "createTungstenFabricFirewallPolicy", + "params": [ + { + "description": "Tungsten-Fabric firewall policy name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the sequence of Tungsten-Fabric firewall policy", + "length": 255, + "name": "sequence", + "required": true, + "type": "integer" + } + ], + "related": "listTungstenFabricFirewallPolicy", + "response": [ + { + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall policy name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric firewall policy uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + } + ] + }, { "description": "Lists all egress firewall rules for network ID.", "isasync": false, "name": "listEgressFirewallRules", "params": [ { - "description": "Lists rule with the specified ID.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the network ID for the egress firewall services", "length": 255, - "name": "account", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -13726,26 +14247,32 @@ "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": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { "description": "the ID of IP address of the firewall services", @@ -13756,24 +14283,24 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "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 objects by project; if projectid=-1 lists All VMs", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": false, "type": "uuid" }, @@ -13785,60 +14312,79 @@ "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "the network ID for the egress firewall services", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" } ], "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", "response": [ + {}, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, { "description": "type of the icmp message being sent", "name": "icmptype", "type": "integer" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the 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 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": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -13852,23 +14398,33 @@ "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": "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" } ], "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", @@ -13879,41 +14435,6 @@ "name": "protocol", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" - }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "the state of the rule", @@ -13921,25 +14442,24 @@ "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "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", "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" } ] }, @@ -13948,13 +14468,6 @@ "isasync": false, "name": "updateRegion", "params": [ - { - "description": "updates region with this name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "Id of region to update", "length": 255, @@ -13962,6 +14475,13 @@ "required": true, "type": "integer" }, + { + "description": "updates region with this name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "updates region with this end point", "length": 255, @@ -13999,15 +14519,15 @@ "name": "name", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if security groups support is enabled, false otherwise", "name": "portableipserviceenabled", "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -14026,27 +14546,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 current status of the latest async job 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" @@ -14057,12 +14577,18 @@ "name": "listClustersMetrics", "params": [ { - "description": "lists clusters by the cluster ID", + "description": "", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "lists clusters by allocation state", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" }, { "description": "lists clusters by the cluster name", @@ -14072,18 +14598,19 @@ "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "List by keyword", "length": 255, - "name": "managedstate", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "lists clusters by Zone ID", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "flag to display the capacity of the clusters", @@ -14093,24 +14620,24 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "keyword", + "name": "id", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists clusters by Zone ID", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "managedstate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists clusters by cluster type", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "clustertype", + "name": "hypervisor", "required": false, "type": "string" }, @@ -14123,149 +14650,55 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "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 hypervisor type", + "description": "", "length": 255, - "name": "hypervisor", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", - "type": "string" - }, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the cluster name", + "name": "name", "type": "string" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - }, { "description": "the total cpu capacity in Ghz", "name": "cputotal", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" - }, - { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the total cpu used in Ghz", - "name": "cpuused", - "type": "string" - }, - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" - }, - { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "running / total hosts in the cluster", - "name": "hosts", - "type": "string" - }, - { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" - }, - { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "state of the cluster", + "name": "state", "type": "string" }, { @@ -14273,14 +14706,14 @@ "name": "capacity", "response": [ { - "description": "the Zone ID", - "name": "zoneid", + "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 Zone name", @@ -14288,28 +14721,28 @@ "type": "string" }, { - "description": "the capacity name", - "name": "name", + "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 capacity currently in allocated", - "name": "capacityallocated", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod name", - "name": "podname", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { @@ -14318,76 +14751,163 @@ "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "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 capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Cluster name", + "name": "clustername", + "type": "string" } ], "type": "list" }, + { + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + { + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" + }, + { + "description": "the total cpu capacity in GiB", + "name": "memorytotal", + "type": "string" + }, + { + "description": "the total cpu used in GiB", + "name": "memoryused", + "type": "string" + }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, + { + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" + }, { "description": "memory allocated notification threshold exceeded", "name": "memoryallocatedthreshold", "type": "boolean" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" + }, + { + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", + "type": "string" }, { - "description": "state of the cluster", - "name": "state", + "description": "the total cpu used in Ghz", + "name": "cpuused", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "running / total hosts in the cluster", + "name": "hosts", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, + { + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + {}, { "description": "the type of the cluster", "name": "clustertype", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", + "type": "string" + }, + { + "description": "the cluster ID", + "name": "id", + "type": "string" + }, + {}, + { + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, { "description": "the total cpu allocated in Ghz", "name": "cpuallocated", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" } ], @@ -14398,14 +14918,6 @@ "isasync": false, "name": "listProjectRolePermissions", "params": [ - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" - }, { "description": "ID of the project", "length": 255, @@ -14413,42 +14925,50 @@ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, "type": "uuid" + }, + { + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "createProjectRole,listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" } ], "related": "createProjectRolePermission", "response": [ { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the ID of the project", - "name": "projectid", + "description": "the 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 ID of the project", + "name": "projectid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", + "type": "string" }, - {}, { "description": "the ID of the project role permission", "name": "id", @@ -14460,9 +14980,9 @@ "type": "string" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.15.0" @@ -14481,76 +15001,76 @@ "type": "uuid" }, { - "description": "Hostname", + "description": "", "length": 255, - "name": "hostname", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "since": "4.13.2", + "type": "boolean" }, { - "description": "Port", + "description": "", "length": 255, - "name": "port", + "name": "page", "required": false, "type": "integer" }, { - "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", + "description": "Hostname", "length": 255, - "name": "listall", + "name": "hostname", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "Port", "length": 255, - "name": "page", + "name": "port", "required": false, "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "addLdapConfiguration,deleteLdapConfiguration", "response": [ - {}, { - "description": "name of the host running the ldap server", - "name": "hostname", + "description": "linked domain", + "name": "domainid", "type": "string" }, {}, { - "description": "port teh ldap server is running on", - "name": "port", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting 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 teh ldap server is running on", + "name": "port", + "type": "int" }, { - "description": "linked domain", - "name": "domainid", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" } ], @@ -14561,13 +15081,6 @@ "isasync": false, "name": "listSecondaryStagingStores", "params": [ - { - "description": "the staging store protocol", - "length": 255, - "name": "protocol", - "required": false, - "type": "string" - }, { "description": "the name of the staging store", "length": 255, @@ -14590,20 +15103,19 @@ "type": "integer" }, { - "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": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -14613,9 +15125,17 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of the staging store", "length": 255, - "name": "keyword", + "name": "id", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "required": false, + "type": "uuid" + }, + { + "description": "the staging store protocol", + "length": 255, + "name": "protocol", "required": false, "type": "string" } @@ -14623,18 +15143,18 @@ "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { @@ -14643,23 +15163,23 @@ "type": "long" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { @@ -14667,33 +15187,33 @@ "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 total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, { - "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" - }, - {} + } ], "since": "4.2.0" }, @@ -14703,11 +15223,12 @@ "name": "createRemoteAccessVpn", "params": [ { - "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", + "description": "public ip address id of the vpn server", "length": 255, - "name": "iprange", - "required": false, - "type": "string" + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { "description": "an optional field, whether to the display the vpn to the end user or not", @@ -14718,62 +15239,76 @@ "type": "boolean" }, { - "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "openfirewall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitely. Has value true by default", + "description": "an optional account for the VPN. Must be used with domainId.", "length": 255, - "name": "openfirewall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "public ip address id of the vpn server", + "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "name": "iprange", + "required": false, + "type": "string" }, { - "description": "an optional account for the VPN. Must be used with domainId.", + "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" } ], "related": "listRemoteAccessVpns,updateRemoteAccessVpn", "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 state of the rule", "name": "state", "type": "string" }, - {}, + { + "description": "the public ip address of the vpn server", + "name": "publicipid", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the 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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the public ip address of the vpn server", - "name": "publicipid", + "name": "publicip", "type": "string" }, { @@ -14781,6 +15316,12 @@ "name": "project", "type": "string" }, + {}, + { + "description": "the range of ips to allocate to the clients", + "name": "iprange", + "type": "string" + }, { "description": "the ipsec preshared key", "name": "presharedkey", @@ -14792,34 +15333,13 @@ "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "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 range of ips to allocate to the clients", - "name": "iprange", - "type": "string" - }, - {}, - { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" } ] @@ -14841,38 +15361,8 @@ "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "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 gateway for the router", - "name": "gateway", - "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 account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { @@ -14881,19 +15371,42 @@ "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the id of the router", + "name": "id", "type": "string" }, + {}, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "list" }, { "description": "the link local MAC address for the router", @@ -14901,18 +15414,8 @@ "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { @@ -14921,54 +15424,13 @@ "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -14977,33 +15439,18 @@ "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the version of template", - "name": "version", - "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 template name for the router", + "name": "templatename", "type": "string" }, { @@ -15012,28 +15459,23 @@ "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", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { @@ -15041,56 +15483,10 @@ "name": "softwareversion", "type": "string" }, + {}, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the 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" - } - ], - "type": "list" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -15103,48 +15499,43 @@ "name": "dns2", "type": "string" }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 ip address of the nic", - "name": "ipaddress", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -15152,14 +15543,24 @@ "name": "gateway", "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", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -15168,48 +15569,48 @@ "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "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 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", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -15217,24 +15618,24 @@ "name": "nsxlogicalswitchport", "type": "string" }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, { "description": "true if nic is default, false otherwise", "name": "macaddress", "type": "string" }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, { "description": "the isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -15243,365 +15644,261 @@ "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" } ], "type": "set" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the Zone ID for the router", + "name": "zoneid", "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 the router", - "name": "name", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" - } - ] - }, - { - "description": "Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for this command to take effect. Note that it only changes the VM's compute offering and it does not update the root volume offering. If the Service Offering has a root disk size the volume will be resized only if using API command 'scaleVirtualMachine'.", - "isasync": false, - "name": "changeServiceForVirtualMachine", - "params": [ - { - "description": "New maximum number of IOPS for the custom disk offering", - "length": 255, - "name": "maxiops", - "required": false, - "since": "4.17", - "type": "long" }, { - "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", - "length": 255, - "name": "automigrate", - "required": false, - "since": "4.17", - "type": "boolean" + "description": "the domain associated with the router", + "name": "domain", + "type": "string" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" + "description": "the account associated with the router", + "name": "account", + "type": "string" }, { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.17", - "type": "long" + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" }, { - "description": "the service offering ID to apply to the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" }, { - "description": "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the host ID for the router", + "name": "hostid", + "type": "string" }, { - "description": "Verify OK to Shrink", - "length": 255, - "name": "shrinkok", - "required": false, - "since": "4.17", - "type": "boolean" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "response": [ - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "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 state of the router", + "name": "state", + "type": "state" }, - {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "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", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "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 public netmask for the router", + "name": "publicnetmask", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "description": "the template ID for the router", "name": "templateid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + } + ] + }, + { + "description": "(This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for this command to take effect.", + "isasync": false, + "name": "changeServiceForVirtualMachine", + "params": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, + "since": "4.17", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "length": 255, + "name": "automigrate", + "required": false, + "since": "4.17", + "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "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" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.17", + "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, + "description": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.17", + "type": "long" + } + ], + "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,importUnmanagedInstance", + "response": [ { "description": "true if high-availability is enabled, false otherwise", "name": "haenable", "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "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": "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": "publicip", "type": "string" }, { @@ -15609,398 +15906,166 @@ "name": "displayvm", "type": "boolean" }, - { - "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "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 vm", - "name": "ostypeid", - "type": "string" - }, - {}, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "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 target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", - "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": "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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": "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" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the 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": "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", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "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 gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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" }, { @@ -16009,51 +16074,41 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { "description": "tag value", "name": "value", "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" } ], "type": "set" }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, { "description": "the number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", "type": "integer" }, { - "description": "the project name of the group", - "name": "project", + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -16062,141 +16117,32 @@ "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the project name of the group", + "name": "project", "type": "string" }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, { "description": "the account owning the security group", "name": "account", "type": "string" }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the 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" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -16205,18 +16151,13 @@ "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", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -16229,23 +16170,23 @@ "name": "tags", "response": [ { - "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": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -16254,644 +16195,582 @@ "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": "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 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": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "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": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" - } - ] - }, - { - "description": "Resets a configuration. The configuration will be set to default value for global setting, and removed from account_details or domain_details for Account/Domain settings", - "isasync": false, - "name": "resetConfiguration", - "params": [ - { - "description": "the ID of the Zone to reset the parameter value for corresponding zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the 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 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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the name of the configuration", - "length": 255, - "name": "name", - "required": true, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "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" - } - ], - "related": "listConfigurations,updateConfiguration", - "response": [ + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, { - "description": "the name of the configuration", - "name": "name", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, - {}, { - "description": "the value of the configuration", - "name": "id", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, - {}, { - "description": "the description of the configuration", - "name": "description", + "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 ID of 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 value of the configuration", - "name": "value", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" - }, - { - "description": "the category of the configuration", - "name": "category", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" - } - ], - "since": "4.16.0" - }, - { - "description": "Lists all available OS mappings for given hypervisor", - "isasync": false, - "name": "listGuestOsMapping", - "params": [ - { - "description": "list mapping by its UUID", - "length": 255, - "name": "id", - "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", - "required": false, - "type": "uuid" }, { - "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", - "length": 255, - "name": "hypervisorversion", - "required": false, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "list mapping by Guest OS Type UUID", - "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "list Guest OS mapping by hypervisor", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "addGuestOsMapping,updateGuestOsMapping", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "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 project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + } + ], + "type": "set" }, - {}, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, - {}, { - "description": "the hypervisor", - "name": "hypervisor", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", - "type": "string" - } - ], - "since": "4.4.0" - }, - { - "description": "List all public, private, and privileged templates.", - "isasync": false, - "name": "listTemplates", - "params": [ + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, { - "description": "list templates by zoneId", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "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 write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "If set to true, list only unique templates across zones", - "length": 255, - "name": "showunique", - "required": false, - "since": "4.13.2", - "type": "boolean" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "show removed templates as well", - "length": 255, - "name": "showremoved", - "required": false, - "type": "boolean" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "flag to display the resource image for the templates", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the template ID", - "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": false, - "type": "uuid" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", - "length": 255, - "name": "templatefilter", - "required": true, + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the template name", - "length": 255, - "name": "name", - "required": false, + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the IDs of the templates, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": false, - "since": "4.9", - "type": "list" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "list datadisk templates by parent template id", - "length": 255, - "name": "parenttemplateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": false, - "since": "4.4", - "type": "uuid" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the hypervisor for which to restrict the search", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "State of the Service from LB rule", + "name": "servicestate", "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": "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" - } - ], - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "response": [ - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the template name", + "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the status of the template", - "name": "status", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the size of the template", - "name": "size", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "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 URL which the template/iso is registered from", - "name": "url", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "checksum of the template", - "name": "checksum", + "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -16900,13 +16779,13 @@ "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 value", + "name": "value", "type": "string" }, { @@ -16914,153 +16793,190 @@ "name": "account", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "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 ID of the secondary storage host for the template", - "name": "hostid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, + {}, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the template ID", + "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, - {}, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "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", + "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 action to be executed if all the conditions evaluate to true for the specified duration.", + "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", "length": 255, - "name": "action", + "name": "clusterid", + "related": "addCluster,updateCluster", + "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" }, { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "description": "the ID of the Account to reset the parameter value for corresponding account", "length": 255, - "name": "quiettime", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", "length": 255, - "name": "conditionids", - "related": "createCondition,listConditions", - "required": true, - "type": "list" + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" }, { - "description": "the duration for which the conditions have to be true before action is taken", + "description": "the ID of the Image Store to reset the parameter value for corresponding image store", "length": 255, - "name": "duration", - "required": true, - "type": "integer" + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "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" } ], - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "related": "listConfigurations,updateConfiguration", "response": [ {}, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the description of the configuration", + "name": "description", "type": "string" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "the value of the configuration", + "name": "value", "type": "string" }, + {}, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the component of the configuration", + "name": "component", "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { @@ -17069,153 +16985,99 @@ "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", - "type": "integer" - }, - { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" - }, - { - "description": "the 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 project name of the autoscale policy", - "name": "project", + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, - {} - ] - }, - { - "description": "Removes stratosphere ssp server", - "isasync": false, - "name": "deleteStratosphereSsp", - "params": [ - { - "description": "the host ID of ssp server", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, { - "description": "any text associated with the success or failure", + "description": "the display text of the configuration", "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the value of the configuration", + "name": "id", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group of the configuration", + "name": "group", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Lists Usage Server metrics", - "isasync": false, - "name": "listUsageServerMetrics", - "params": [], - "related": "", - "response": [ - {}, - { - "description": "the last time a usage job successfully completed", - "name": "lastsuccessfuljob", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" - }, - { - "description": "the last time this Usage Server checked for jobs", - "name": "lastheartbeat", - "type": "date" + "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": "the possible options of the configuration value", + "name": "options", "type": "string" }, - {}, { - "description": "the state of the usage server", - "name": "state", - "type": "state" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the name of the active usage server", - "name": "hostname", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" } ], - "since": "4.17.0" + "since": "4.16.0" }, { - "description": "Lists physical networks", + "description": "Lists all available OS mappings for given hypervisor", "isasync": false, - "name": "listPhysicalNetworks", + "name": "listGuestOsMapping", "params": [ { - "description": "the Zone ID for the physical network", + "description": "list mapping by its UUID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", "required": false, "type": "uuid" }, { - "description": "list physical network by id", + "description": "", "length": 255, - "name": "id", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "search by name", + "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", "length": 255, - "name": "name", + "name": "hypervisorversion", "required": false, "type": "string" }, { - "description": "", + "description": "list Guest OS mapping by hypervisor", "length": 255, - "name": "pagesize", + "name": "hypervisor", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "list mapping by Guest OS Type UUID", + "length": 255, + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", + "required": false, + "type": "uuid" }, { "description": "List by keyword", @@ -17227,195 +17089,172 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], - "related": "createPhysicalNetwork,updatePhysicalNetwork", + "related": "addGuestOsMapping,updateGuestOsMapping", "response": [ { - "description": "comma separated tag", - "name": "tags", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "name of the physical network", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "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": "state of the physical network", - "name": "state", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, + {}, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "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", + "description": "the ID of the Guest OS mapping", "name": "id", "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", - "type": "string" - }, - { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" } ], - "since": "3.0.0" + "since": "4.4.0" }, { - "description": "Enables HA for a zone", - "isasync": true, - "name": "enableHAForZone", + "description": "List all public, private, and privileged templates.", + "isasync": false, + "name": "listTemplates", "params": [ { - "description": "ID of the zone", + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ + "name": "showunique", + "required": false, + "since": "4.13.2", + "type": "boolean" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "flag to display the resource image for the templates", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list templates by zoneId", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, "type": "boolean" }, - {} - ], - "since": "4.11" - }, - { - "description": "Lists all firewall rules for an IP address.", - "isasync": false, - "name": "listFirewallRules", - "params": [ { - "description": "Lists rule with the specified ID.", + "description": "", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "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 firewall rules for certain network", + "description": "list datadisk templates by parent template id", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "parenttemplateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "since": "4.3", + "since": "4.4", "type": "uuid" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "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": "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": "listall", - "required": false, - "type": "boolean" + "name": "templatefilter", + "required": true, + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the template name", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "show removed templates as well", "length": 255, - "name": "pagesize", + "name": "showremoved", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "isrecursive", + "name": "ids", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "boolean" + "since": "4.9", + "type": "list" }, { "description": "List by keyword", @@ -17425,562 +17264,551 @@ "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the template ID", "length": 255, - "name": "account", + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, { - "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": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "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" } ], - "related": "createFirewallRule,updateEgressFirewallRule", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "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": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, - {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "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 firewall rule", - "name": "id", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "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", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, - {}, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "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": "Cleanups VM reservations in the database.", - "isasync": true, - "name": "cleanVMReservations", - "params": [], - "response": [ + "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", + "description": "the template display text", + "name": "displaytext", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": " delete a Brocade VCS Switch", - "isasync": true, - "name": "deleteBrocadeVcsDevice", - "params": [ - { - "description": "Brocade Switch ID", - "length": 255, - "name": "vcsdeviceid", - "related": "addBrocadeVcsDevice,listBrocadeVcsDevices", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the status of the template", + "name": "status", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - } - ] - }, - { - "description": "Extracts an ISO", - "isasync": true, - "name": "extractIso", - "params": [ - { - "description": "the ID of the zone where the ISO is originally located", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", - "length": 255, - "name": "mode", - "required": true, + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the URL to which the ISO would be extracted", - "length": 2048, - "name": "url", - "required": false, - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the ID of the ISO file", - "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" - } - ], - "related": "extractTemplate,extractVolume", - "response": [ - { - "description": "type of the storage", - "name": "storagetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, - {}, { - "description": "", - "name": "resultstring", + "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 ID of the zone for this template", + "name": "zoneid", + "type": "string" }, - {}, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "zone name the object was extracted from", + "description": "the name of the zone for this template", "name": "zonename", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "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 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 percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "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 template name", + "name": "name", "type": "string" }, { - "description": "the id of extracted object", - "name": "id", + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" } ] }, { - "description": "create secondary staging store.", - "isasync": false, - "name": "createSecondaryStagingStore", + "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 scope of the staging store: zone only for now", + "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, - "name": "scope", - "required": false, - "type": "string" + "name": "conditionids", + "related": "createCondition,listConditions", + "required": true, + "type": "list" }, { - "description": "the staging store provider name", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "provider", + "name": "quiettime", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the URL for the staging store", - "length": 2048, - "name": "url", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "length": 255, + "name": "action", "required": true, "type": "string" }, { - "description": "the Zone ID for the staging store", + "description": "the duration in which the conditions have to be true before action is taken", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "name": "duration", + "required": true, + "type": "integer" }, { - "description": "the details for the staging store", + "description": "the name of the autoscale policy", "length": 255, - "name": "details", + "name": "name", "required": false, - "type": "map" + "since": "4.18.0", + "type": "string" } ], - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "response": [ + {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - { - "description": "the protocol of the image store", - "name": "protocol", + "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", + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, {}, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" + }, + { + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, { - "description": "the 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 url of the image store", - "name": "url", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, - {}, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "name of the autoscale policy", + "name": "name", + "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Creates an affinity/anti-affinity group", - "isasync": true, - "name": "createAffinityGroup", + "description": "Removes stratosphere ssp server", + "isasync": false, + "name": "deleteStratosphereSsp", "params": [ { - "description": "Type of the affinity group from the available affinity/anti-affinity group types", + "description": "the host ID of ssp server", "length": 255, - "name": "type", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "an account for the affinity group. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the affinity group", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "create Tungsten-Fabric policy", + "isasync": true, + "name": "createTungstenFabricPolicy", + "params": [ + { + "description": "Tungsten-Fabric policy name", "length": 255, "name": "name", "required": true, "type": "string" }, { - "description": "optional description of the affinity group", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, - { - "description": "create affinity group for project", + "description": "the ID of zone", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" } ], - "related": "", + "related": "listTungstenFabricPolicy,removeTungstenFabricPolicyRule,applyTungstenFabricPolicy,removeTungstenFabricPolicy", "response": [ { - "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 ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, { @@ -17988,10 +17816,12 @@ "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -17999,42 +17829,49 @@ "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "list Tungsten-Fabric policy network name", + "name": "network", "type": "list" }, - {}, { - "description": "the name of the affinity group", - "name": "name", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" - } + }, + {} ] }, { - "description": "Remove a VMware datacenter from a zone.", + "description": "Lists Usage Server metrics", "isasync": false, - "name": "removeVmwareDc", - "params": [ - { - "description": "The id of Zone from which VMware datacenter has to be removed.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], + "name": "listUsageServerMetrics", + "params": [], + "related": "", "response": [ + { + "description": "the last time a usage job successfully completed", + "name": "lastsuccessfuljob", + "type": "date" + }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" + }, + { + "description": "the state of the usage server", + "name": "state", + "type": "state" + }, + { + "description": "the name of the active usage server", + "name": "hostname", "type": "string" }, { @@ -18042,50 +17879,59 @@ "name": "jobid", "type": "string" }, + { + "description": "the last time this Usage Server checked for jobs", + "name": "lastheartbeat", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] + {} + ], + "since": "4.17.0" }, { - "description": "Lists all available Internal Load Balancer elements.", + "description": "Lists physical networks", "isasync": false, - "name": "listInternalLoadBalancerElements", + "name": "listPhysicalNetworks", "params": [ { - "description": "", + "description": "search by name", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list internal load balancer elements by enabled state", + "description": "the Zone ID for the physical network", "length": 255, - "name": "enabled", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list internal load balancer elements by network service provider id", + "description": "", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list physical network by id", + "length": 255, + "name": "id", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -18095,236 +17941,320 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "list internal load balancer elements by id", - "length": 255, - "name": "id", - "related": "configureInternalLoadBalancerElement,createInternalLoadBalancerElement,listInternalLoadBalancerElements", - "required": false, - "type": "uuid" } ], - "related": "configureInternalLoadBalancerElement,createInternalLoadBalancerElement", + "related": "createPhysicalNetwork,updatePhysicalNetwork", "response": [ { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" - }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the id of the internal load balancer element", - "name": "id", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "the physical network service provider id of the element", - "name": "nspid", + "description": "comma separated tag", + "name": "tags", "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Updates load balancer health check policy", - "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, - "name": "customid", - "required": false, - "since": "4.4", + "description": "state of the physical network", + "name": "state", "type": "string" }, { - "description": "an optional field, whether to the display the policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - } - ], - "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", - "response": [ + "description": "zone id of the physical network", + "name": "zoneid", + "type": "string" + }, { - "description": "the domain of the HealthCheck policy", - "name": "domain", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "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": "name of the physical network", + "name": "name", + "type": "string" }, { - "description": "the list of healthcheckpolicies", - "name": "healthcheckpolicy", - "response": [ - { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" - }, - { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" - }, - { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "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": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" - }, - { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" } ], - "since": "4.4" + "since": "3.0.0" }, { - "description": "Reboots a virtual machine.", + "description": "Enables HA for a zone", "isasync": true, - "name": "rebootVirtualMachine", + "name": "enableHAForZone", "params": [ { - "description": "Boot into hardware setup menu or not", + "description": "ID of the zone", "length": 255, - "name": "bootintosetup", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ], + "since": "4.11" + }, + { + "description": "Lists all firewall rules for an IP address.", + "isasync": false, + "name": "listFirewallRules", + "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, - "since": "4.15.0.0", "type": "boolean" }, { - "description": "The ID of the virtual machine", + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "the ID of IP address of the firewall services", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" + }, + { + "description": "Lists rule with the specified ID.", "length": 255, "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": false, "type": "uuid" }, { - "description": "Force reboot the VM (VM is Stopped and then Started)", + "description": "", "length": 255, - "name": "forced", + "name": "pagesize", "required": false, - "since": "4.16.0", + "type": "integer" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list firewall rules for certain network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "since": "4.3", + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "related": "createFirewallRule,updateEgressFirewallRule", "response": [ { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the list of resource tags associated", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "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 traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + {}, + { + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -18333,18 +18263,18 @@ "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": "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" }, { @@ -18353,690 +18283,273 @@ "type": "string" }, { - "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" } ], - "type": "set" + "type": "list" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "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": "Cleanups VM reservations in the database.", + "isasync": true, + "name": "cleanVMReservations", + "params": [], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the 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": "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 IPv6 address of network", - "name": "ip6address", - "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 gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - } - ], - "type": "set" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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 ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the 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" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": " delete a Brocade VCS Switch", + "isasync": true, + "name": "deleteBrocadeVcsDevice", + "params": [ { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, + "description": "Brocade Switch ID", + "length": 255, + "name": "vcsdeviceid", + "related": "addBrocadeVcsDevice,listBrocadeVcsDevices", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the 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", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" - }, + } + ] + }, + { + "description": "Extracts an ISO", + "isasync": true, + "name": "extractIso", + "params": [ { - "description": "the project id of the vm", - "name": "projectid", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the URL to which the ISO would be extracted", + "length": 2048, + "name": "url", + "required": false, "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the ID of the ISO file", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, + "description": "the ID of the zone where the ISO is originally located", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "extractTemplate,extractVolume", + "response": [ { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the id of extracted object", + "name": "id", "type": "string" }, + {}, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "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 service offering of the virtual machine", - "name": "serviceofferingname", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, + {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the status of the extraction", + "name": "status", "type": "string" - }, + } + ] + }, + { + "description": "create secondary staging store.", + "isasync": false, + "name": "createSecondaryStagingStore", + "params": [ { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the staging store provider name", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the URL for the staging store", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the Zone ID for the staging store", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the details for the staging store", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "the scope of the staging store: zone only for now", + "length": 255, + "name": "scope", + "required": false, "type": "string" + } + ], + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "response": [ + { + "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 Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the url of the image store", + "name": "url", "type": "string" }, { @@ -19045,575 +18558,475 @@ "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the image store", + "name": "id", "type": "string" }, {}, - {}, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, + {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + } + ] + }, + { + "description": "Creates an affinity/anti-affinity group", + "isasync": true, + "name": "createAffinityGroup", + "params": [ + { + "description": "Type of the affinity group from the available affinity/anti-affinity group types", + "length": 255, + "name": "type", + "required": true, "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "create affinity group for project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, - {}, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "optional description of the affinity group", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "name of the affinity group", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "an account for the affinity group. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "domainId of the account owning the affinity group", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, + {}, + {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the description of the affinity group", + "name": "description", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain ID of the affinity group", + "name": "domainid", + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the account owning the affinity group", + "name": "account", "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the project name of the affinity group", + "name": "project", + "type": "string" } ] }, { - "description": "Enables HA cluster-wide", - "isasync": true, - "name": "enableHAForCluster", + "description": "Remove a VMware datacenter from a zone.", + "isasync": false, + "name": "removeVmwareDc", "params": [ { - "description": "ID of the cluster", + "description": "The id of Zone from which VMware datacenter has to be removed.", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.11" + {} + ] }, { - "description": "Creates a load balancer rule", - "isasync": true, - "name": "createLoadBalancerRule", + "description": "Lists all available Internal Load Balancer elements.", + "isasync": false, + "name": "listInternalLoadBalancerElements", "params": [ { - "description": "the public port from where the network traffic will be load balanced from", - "length": 255, - "name": "publicport", - "required": true, - "type": "integer" - }, - { - "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", - "length": 255, - "name": "protocol", - "required": false, - "type": "string" - }, - { - "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", + "description": "list internal load balancer elements by id", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "createInternalLoadBalancerElement,configureInternalLoadBalancerElement,listInternalLoadBalancerElements", "required": false, "type": "uuid" }, { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", + "description": "", "length": 255, - "name": "cidrlist", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the domain ID associated with the load balancer", + "description": "list internal load balancer elements by network service provider id", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", "required": false, "type": "uuid" }, { - "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", + "description": "", "length": 255, - "name": "privateport", - "required": true, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "description": "list internal load balancer elements by enabled state", + "length": 255, + "name": "enabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "public IP address ID from where the network traffic will be load balanced from", + "description": "List by keyword", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "keyword", "required": false, - "type": "uuid" - }, + "type": "string" + } + ], + "related": "createInternalLoadBalancerElement,configureInternalLoadBalancerElement", + "response": [ { - "description": "name of the load balancer rule", - "length": 255, - "name": "name", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitely. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", - "length": 255, - "name": "openfirewall", - "required": false, + "description": "Enabled/Disabled the element", + "name": "enabled", "type": "boolean" }, { - "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": true, + "description": "the physical network service provider id of the element", + "name": "nspid", "type": "string" }, { - "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} + ], + "since": "4.2.0" + }, + { + "description": "Updates load balancer health check policy", + "isasync": true, + "name": "updateLBHealthCheckPolicy", + "params": [ + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "account", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "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 load balancer health check policy", + "length": 255, + "name": "id", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies,updateLBHealthCheckPolicy", + "required": true, + "type": "uuid" } ], - "related": "listLoadBalancerRules,updateLoadBalancerRule", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "response": [ + { + "description": "the account of the HealthCheck policy", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the list of resource tags associated with load balancer", - "name": "tags", + "description": "the list of healthcheckpolicies", + "name": "healthcheckpolicy", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the description of the healthcheck policy", + "name": "description", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" }, { - "description": "tag value", - "name": "value", + "description": "the LB HealthCheck policy ID", + "name": "id", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ], "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, + } + ], + "since": "4.4" + }, + { + "description": "remove Tungsten-Fabric policy", + "isasync": true, + "name": "removeTungstenFabricPolicyRule", + "params": [ { - "description": "the state of the rule", - "name": "state", + "description": "the Uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the Uuid of Tungsten-Fabric policy rule", + "length": 255, + "name": "ruleuuid", + "required": true, "type": "string" - }, + } + ], + "related": "listTungstenFabricPolicy,applyTungstenFabricPolicy,removeTungstenFabricPolicy", + "response": [ {}, { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", + "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, - {}, { - "description": "the name of the load balancer", + "description": "Tungsten-Fabric policy name", "name": "name", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Import vSphere storage policies", - "isasync": false, - "name": "importVsphereStoragePolicies", - "params": [ - { - "description": "ID of the zone", - "length": 255, + "description": "Tungsten-Fabric provider zone id", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "listVsphereStoragePolicies", - "response": [ - { - "description": "the ID of the Storage Policy", - "name": "id", - "type": "string" - }, - { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", - "type": "string" + "type": "long" }, - {}, { - "description": "the description of the Storage Policy", - "name": "description", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", - "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", @@ -19621,11 +19034,7 @@ "type": "string" }, {}, - { - "description": "the name of the Storage Policy", - "name": "name", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -19634,1277 +19043,1448 @@ ] }, { - "description": "Adds a guest OS name to hypervisor OS name mapping", - "isasync": true, - "name": "addGuestOsMapping", + "description": "Create Tungsten-Fabric provider in cloudstack", + "isasync": false, + "name": "createTungstenFabricProvider", "params": [ { - "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", - "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" - }, - { - "description": "OS name specific to the hypervisor", + "description": "Tungsten-Fabric provider name", "length": 255, - "name": "osnameforhypervisor", + "name": "name", "required": true, "type": "string" }, { - "description": "Hypervisor version to create the mapping for. Use 'default' for default versions", + "description": "Tungsten-Fabric provider gateway", "length": 255, - "name": "hypervisorversion", + "name": "tungstengateway", "required": true, "type": "string" }, { - "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", + "description": "Tungsten-Fabric provider introspect port", "length": 255, - "name": "osdisplayname", + "name": "tungstenproviderintrospectport", "required": false, "type": "string" }, { - "description": "Hypervisor type. One of : XenServer, KVM, VMWare", + "description": "Tungsten-Fabric provider vrouter port", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - } - ], - "related": "updateGuestOsMapping", - "response": [ - { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the hypervisor", - "name": "hypervisor", + "name": "tungstenprovidervrouterport", + "required": false, "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "Tungsten-Fabric provider hostname", + "length": 255, + "name": "tungstenproviderhostname", + "required": true, "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "Tungsten-Fabric provider port", + "length": 255, + "name": "tungstenproviderport", + "required": false, "type": "string" - }, + } + ], + "related": "listTungstenFabricProviders", + "response": [ + {}, { "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": "Tungsten-Fabric provider name", + "name": "name", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", "type": "string" }, - {} - ], - "since": "4.4.0" - }, - { - "description": "Disables out-of-band management for a zone", - "isasync": true, - "name": "disableOutOfBandManagementForZone", - "params": [ - { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", - "response": [ { - "description": "the operation result", - "name": "status", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, - {}, - { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" - }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the operation result description", - "name": "description", + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "the out-of-band management interface address", - "name": "address", + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "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" } - ], - "since": "4.9.0" + ] }, { - "description": "Updates a network offering.", - "isasync": false, - "name": "updateNetworkOffering", + "description": "Reboots a virtual machine.", + "isasync": true, + "name": "rebootVirtualMachine", "params": [ { - "description": "sort key of the network offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "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.", + "description": "Boot into hardware setup menu or not", "length": 255, - "name": "keepaliveenabled", + "name": "bootintosetup", "required": false, + "since": "4.15.0.0", "type": "boolean" }, { - "description": "the name of the network offering", + "description": "Force reboot the VM (VM is Stopped and then Started)", "length": 255, - "name": "name", + "name": "forced", "required": false, - "type": "string" + "since": "4.16.0", + "type": "boolean" }, { - "description": "the id of the network offering", + "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", - "required": false, + "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,importUnmanagedInstance", + "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,importUnmanagedInstance", + "response": [ + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, + {}, { - "description": "the display text of the network offering", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the availability of network offering. Default value is Required for Guest Virtual network offering; Optional for Guest Direct network offering", - "length": 255, - "name": "availability", - "required": false, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "update state for the network offering", - "length": 255, + "description": "the state of the virtual machine", "name": "state", - "required": false, "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 4096, - "name": "zoneid", - "required": false, - "since": "4.13", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "maximum number of concurrent connections supported by the network offering", - "length": 255, - "name": "maxconnections", - "required": false, + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 255, - "name": "domainid", - "required": false, + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", - "required": false, + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" - } - ], - "related": "createNetworkOffering,listNetworkOfferings", - "response": [ + }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, + {}, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" + "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 project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" + "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 name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the list of supported services", - "name": "service", + "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", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "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 name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the 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": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - } - ], + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the service name", - "name": "name", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" - }, - { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" - }, - { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" - }, - { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "the id of the network offering", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, - { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", - "type": "string" - }, - { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "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": "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": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" - }, - { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "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", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the network offering", - "name": "name", - "type": "string" - }, - {}, - {}, - { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", - "type": "string" - } - ] - }, - { - "description": "Lists all IPv6 firewall rules", - "isasync": false, - "name": "listIpv6FirewallRules", - "params": [ - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "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, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "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": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "list ipv6 firewall rules by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "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, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list ipv6 firewall rules by traffic type - ingress or egress", - "length": 255, - "name": "traffictype", - "required": false, - "type": "string" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - } - ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "response": [ - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ + }, { - "description": "tag key name", - "name": "key", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 account associated with the tag", - "name": "account", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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 ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" } ], - "type": "list" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" + "type": "set" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the name of the host for the virtual machine", + "name": "hostname", "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. The caller knows the VM is stopped.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - } - ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "response": [ - { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the 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": "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the 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": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project 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" + } + ], + "type": "set" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the template name for the system VM", + "description": "the name of the template for the virtual machine", "name": "templatename", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, + {}, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the project name of the vm", + "name": "project", + "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + } ] }, { - "description": "Deletes an egress firewall rule", + "description": "Enables HA cluster-wide", "isasync": true, - "name": "deleteEgressFirewallRule", + "name": "enableHAForCluster", "params": [ { - "description": "the ID of the firewall rule", + "description": "ID of the cluster", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "clusterid", + "related": "addCluster,updateCluster", "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": "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.11" }, { - "description": "Updates a VPC", + "description": "Creates a load balancer rule", "isasync": true, - "name": "updateVPC", + "name": "createLoadBalancerRule", "params": [ { - "description": "the display text of the VPC", + "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", "length": 255, - "name": "displaytext", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, + "type": "uuid" + }, + { + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", + "required": true, "type": "string" }, { - "description": "the name of the VPC", + "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": "name", + "name": "openfirewall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the id of the VPC", + "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": "id", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", "length": 255, - "name": "customid", + "name": "protocol", "required": false, - "since": "4.4", "type": "string" }, { - "description": "an optional field, whether to the display the vpc to the end user or not", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, "name": "fordisplay", "required": false, "since": "4.4", "type": "boolean" - } - ], - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "response": [ + }, { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed.", + "length": 255, + "name": "cidrlist", + "required": false, + "since": "4.18.0.0", + "type": "list" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", + "length": 255, + "name": "privateport", + "required": true, + "type": "integer" + }, + { + "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the id of the VPC", - "name": "id", + "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" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the domain ID associated with the load balancer", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, + { + "description": "the public port from where the network traffic will be load balanced from", + "length": 255, + "name": "publicport", + "required": true, + "type": "integer" + } + ], + "related": "listLoadBalancerRules,updateLoadBalancerRule", + "response": [ + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the domain id of the VPC owner", + "description": "the domain ID of the load balancer rule", "name": "domainid", "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "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 current status of the latest async job acting 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 routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the public port", + "name": "publicport", "type": "string" }, + {}, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the list of resource tags associated with the project", + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -20923,115 +20503,97 @@ "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", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - {}, - { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" - }, - { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "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", + "description": "list Tungsten-Fabric logical router", + "isasync": false, + "name": "listTungstenFabricLogicalRouter", "params": [ { - "description": "the ID of the host", + "description": "the uuid of Tungsten-Fabric logical router", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": true, + "name": "logicalrouteruuid", + "required": false, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, "type": "uuid" }, { - "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", + "description": "", "length": 255, - "name": "password", + "name": "pagesize", "required": false, - "type": "string" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction", - "response": [ + "type": "integer" + }, { - "description": "the operation result description", - "name": "description", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" - }, - { - "description": "the ID of the host", - "name": "hostid", + "description": "the uuid of Tungsten-Fabric network", + "length": 255, + "name": "networkuuid", + "required": false, "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "createTungstenFabricLogicalRouter,addTungstenFabricNetworkGatewayToLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", + "response": [ { - "description": "the out-of-band management interface username", - "name": "username", + "description": "Tungsten-Fabric logical router name", + "name": "name", "type": "string" }, {}, {}, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" - }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, - { - "description": "the out-of-band management interface address", - "name": "address", + "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 policy network name", + "name": "network", + "type": "list" }, { "description": "the current status of the latest async job acting on this object", @@ -21039,344 +20601,282 @@ "type": "integer" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", + "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "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" } - ], - "since": "4.9.0" + ] }, { - "description": "List resource detail(s)", + "description": "Import vSphere storage policies", "isasync": false, - "name": "listResourceDetails", + "name": "importVsphereStoragePolicies", "params": [ { - "description": "list by key", + "description": "ID of the zone", "length": 255, - "name": "key", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, + "type": "uuid" + } + ], + "related": "listVsphereStoragePolicies", + "response": [ + { + "description": "the name of the Storage Policy", + "name": "name", "type": "string" }, { - "description": "if set to true, only details marked with display=true, are returned. False by default", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.3", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", + "type": "string" }, + {}, { - "description": "list by resource id", - "length": 255, - "name": "resourceid", - "required": false, + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { - "description": "list by resource type", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "the description of the Storage Policy", + "name": "description", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, + } + ] + }, + { + "description": "Adds a guest OS name to hypervisor OS name mapping", + "isasync": true, + "name": "addGuestOsMapping", + "params": [ { - "description": "list by key, value. Needs to be passed only along with key", + "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", "length": 255, - "name": "value", + "name": "osdisplayname", "required": false, - "since": "4.4", "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "OS name specific to the hypervisor", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "osnameforhypervisor", + "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": "UUID of Guest OS type. Either the UUID or Display Name must be passed", "length": 255, - "name": "listall", + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "Hypervisor type. One of : XenServer, KVM, VMWare", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "Hypervisor version to create the mapping for. Use 'default' for default versions", "length": 255, - "name": "keyword", - "required": false, + "name": "hypervisorversion", + "required": true, "type": "string" } ], - "related": "listTags", + "related": "updateGuestOsMapping", "response": [ { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, {}, { - "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", + "description": "the hypervisor", + "name": "hypervisor", "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": "resource type", - "name": "resourcetype", + "description": "the ID of the Guest OS mapping", + "name": "id", "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": "tag key name", - "name": "key", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" } ], - "since": "4.2" + "since": "4.4.0" }, { - "description": "Attempts to live patch systemVMs - CPVM, SSVM ", + "description": "Disables out-of-band management for a zone", "isasync": true, - "name": "patchSystemVm", + "name": "disableOutOfBandManagementForZone", "params": [ { - "description": "If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, - { - "description": "patches systemVM - CPVM/SSVM with the specified ID", + "description": "the ID of the zone", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" } ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" + }, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ], - "since": "4.17.0" - }, - { - "description": "Creates a network offering.", - "isasync": false, - "name": "createNetworkOffering", - "params": [ - { - "description": "the ID of the containing zone(s), null for public offerings", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "list" }, + {}, { - "description": "maximum number of concurrent connections supported by the network offering", - "length": 255, - "name": "maxconnections", - "required": false, - "type": "integer" + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" }, { - "description": "the name of the network offering", - "length": 255, - "name": "name", - "required": true, + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the display text of the network offering", - "length": 255, - "name": "displaytext", - "required": true, + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed", - "length": 255, - "name": "networkrate", - "required": false, - "type": "integer" + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "length": 255, - "name": "egressdefaultpolicy", - "required": false, + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", "type": "boolean" }, { - "description": "set to true if the offering is to be enabled during creation. Default is false", - "length": 255, - "name": "enable", - "required": false, - "since": "4.16", - "type": "boolean" + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" }, { - "description": "services supported by the network offering", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", - "required": false, + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "true if network offering supports vlans", - "length": 255, - "name": "specifyvlan", - "required": false, - "type": "boolean" - }, + "description": "the ID of the host", + "name": "hostid", + "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "Updates a network offering.", + "isasync": false, + "name": "updateNetworkOffering", + "params": [ { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "description": "update state for the network offering", "length": 255, - "name": "ispersistent", + "name": "state", "required": false, - "type": "boolean" + "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", + "description": "the name of the network offering", "length": 255, - "name": "serviceproviderlist", + "name": "name", "required": false, - "type": "map" - }, - { - "description": "the traffic type for the network offering. Supported type in current release is GUEST only", - "length": 255, - "name": "traffictype", - "required": true, "type": "string" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", "length": 255, "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "list" + "type": "string" }, { "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", @@ -21386,253 +20886,131 @@ "type": "boolean" }, { - "description": "the availability of network offering. Default value is Optional", - "length": 255, - "name": "availability", + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", "required": false, "type": "string" }, { - "description": "true if network offering is meant to be used for VPC, false otherwise.", + "description": "the display text of the network offering", "length": 255, - "name": "forvpc", + "name": "displaytext", "required": false, - "type": "boolean" + "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", + "description": "maximum number of concurrent connections supported by the network offering", "length": 255, - "name": "details", + "name": "maxconnections", "required": false, - "since": "4.2.0", - "type": "map" + "type": "integer" }, { - "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", - "length": 255, - "name": "internetprotocol", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 4096, + "name": "zoneid", "required": false, - "since": "4.17.0", + "since": "4.13", "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 specifying ip ranges; defaulted to false if not specified", + "description": "the availability of network offering. Default value is Required for Guest Virtual network offering; Optional for Guest Direct network offering", "length": 255, - "name": "specifyipranges", + "name": "availability", "required": false, - "type": "boolean" - }, - { - "description": "guest type of the network offering: Shared or Isolated", - "length": 255, - "name": "guestiptype", - "required": true, "type": "string" }, { - "description": "desired service capabilities as part of network offering", + "description": "sort key of the network offering, integer", "length": 255, - "name": "servicecapabilitylist", + "name": "sortkey", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the service offering ID used by virtual router provider", + "description": "the id of the network offering", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "id", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, "type": "uuid" } ], - "related": "listNetworkOfferings", + "related": "createNetworkOffering,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 the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the id of the network offering", + "name": "id", + "type": "string" + }, + { + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, + {}, { "description": "additional key/value details tied with network offering", "name": "details", "type": "map" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", "type": "boolean" }, { - "description": "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", - "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": "the name of the network offering", - "name": "name", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" }, { "description": "maximum number of concurrents connections to be handled by lb", "name": "maxconnections", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" - }, - { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", - "type": "string" - }, - {}, - { - "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 is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, - { - "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": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" - }, - { - "description": "the id of the network offering", - "name": "id", - "type": "string" - }, - { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "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": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -21651,689 +21029,816 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "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" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" }, + {}, { "description": "the ID of the service offering used by virtual router provider", "name": "serviceofferingid", "type": "string" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", + "type": "string" + }, + { + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" - } - ], - "since": "3.0.0" - }, - { - "description": "Dedicate an existing cluster", - "isasync": true, - "name": "dedicateCluster", - "params": [ + }, { - "description": "the ID of the Cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", + "type": "string" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, - "type": "uuid" - } - ], - "related": "listDedicatedClusters", - "response": [ + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "the ID of the cluster", - "name": "clusterid", - "type": "string" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "availability of the network offering", + "name": "availability", "type": "string" }, - {}, { - "description": "the name of the cluster", - "name": "clustername", + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" + }, + { + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, - {}, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" + }, + { + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" + }, + { + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the 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 date this network offering was created", + "name": "created", + "type": "date" }, { - "description": "the domain ID of the cluster", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domainid", "type": "string" } ] }, { - "description": "Creates an IP forwarding rule", + "description": "Stops a system VM.", "isasync": true, - "name": "createIpForwardingRule", + "name": "stopSystemVm", "params": [ { - "description": "the start port for the rule", + "description": "The ID of the system virtual machine", "length": 255, - "name": "startport", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "the end port for the rule", + "description": "Force stop the VM. The caller knows the VM is stopped.", "length": 255, - "name": "endport", + "name": "forced", "required": false, - "type": "integer" - }, + "type": "boolean" + } + ], + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "response": [ { - "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 first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "the protocol for the rule. Valid values are TCP or UDP.", - "length": 255, - "name": "protocol", - "required": true, + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", - "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" - } - ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "response": [ - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ID of the system VM", + "name": "id", + "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the 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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, - {}, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, {}, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - } - ] - }, - { - "description": "Lists volume metrics", - "isasync": false, - "name": "listVolumesMetrics", - "params": [ + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { - "description": "the IDs of the volumes, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "since": "4.9", - "type": "list" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "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": "the ID of the 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", - "required": false, - "type": "uuid" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "the pod id the disk volume belongs to", - "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the type of disk volume", - "length": 255, - "name": "type", - "required": false, + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "list volumes on specified host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": false, - "type": "uuid" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, + {}, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "displayvolume", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" }, { - "description": "the ID of the storage pool, available to ROOT admin only", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "4.3", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "list volumes by disk offering", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": false, - "since": "4.4", - "type": "uuid" + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" }, { - "description": "the cluster id the disk volume belongs to", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the name of the disk volume", - "length": 255, - "name": "name", - "required": false, + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "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": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { - "description": "the ID of the availability zone", + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Deletes an egress firewall rule", + "isasync": true, + "name": "deleteEgressFirewallRule", + "params": [ + { + "description": "the ID of the firewall rule", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": true, "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "List resources by tags (key/value pairs)", + "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": "Updates a VPC", + "isasync": true, + "name": "updateVPC", + "params": [ + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "tags", + "name": "customid", "required": false, - "type": "map" + "since": "4.4", + "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "the display text of the VPC", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "List by keyword", + "description": "the name of the VPC", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "the id of the VPC", "length": 255, - "name": "state", - "required": false, - "type": "string" + "name": "id", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "isrecursive", + "name": "publicmtu", "required": false, - "type": "boolean" + "since": "4.18.0", + "type": "integer" } ], - "related": "", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "name of the disk volume", - "name": "name", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true VPC requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "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": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "disk size in GiB", - "name": "sizegb", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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": "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 domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" }, + {}, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, - {}, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" + } + ] + }, + { + "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": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", + "length": 255, + "name": "password", + "required": false, "type": "string" - }, + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction", + "response": [ { - "description": "the path of the volume", - "name": "path", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, + {}, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "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", @@ -22341,123 +21846,185 @@ "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the disk utilization", - "name": "utilization", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, + {} + ], + "since": "4.9.0" + }, + { + "description": "Lists all IPv6 firewall rules", + "isasync": false, + "name": "listIpv6FirewallRules", + "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": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "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": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", - "type": "long" + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "type": "boolean" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "Lists ipv6 firewall rule with the specified ID", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": false, + "type": "uuid" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + } + ], + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "response": [ + {}, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "ID of the disk volume", + "description": "the ID of the port forwarding rule", "name": "id", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the list of resource tags associated", + "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": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -22466,23 +22033,23 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -22491,242 +22058,232 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - } - ], - "since": "4.9.3" - }, - { - "description": "Lists the network Interfaces of elastistor", - "isasync": false, - "name": "listElastistorInterface", - "params": [ - { - "description": "controller id", - "length": 255, - "name": "controllerid", - "required": false, + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" - } - ], - "related": "listElastistorVolume", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, - {}, { - "description": "the id of the volume", - "name": "id", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the name of the volume", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "syncronization", - "name": "sync", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "compression", - "name": "compression", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, {}, { - "description": "graceallowed", - "name": "graceallowed", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "deduplication", - "name": "deduplication", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" } ] }, { - "description": "Lists all possible details and their options for a resource type such as a VM or a template", + "description": "List resource detail(s)", "isasync": false, - "name": "listDetailOptions", + "name": "listResourceDetails", "params": [ { - "description": "the UUID of the resource (optional)", + "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 resource id", "length": 255, "name": "resourceid", "required": false, "type": "string" }, { - "description": "the resource type such as UserVm, Template etc.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "resourcetype", - "required": true, + "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": "list by key", + "length": 255, + "name": "key", + "required": false, + "type": "string" }, - {}, { - "description": "Map of all possible details and their possible list of values", - "name": "details", - "type": "map" + "description": "if set to true, only details marked with display=true, are returned. False by default", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.3", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - } - ], - "since": "4.13" - }, - { - "description": "Lists SSL certificates", - "isasync": false, - "name": "listSslCerts", - "params": [ + }, { - "description": "Load balancer rule ID", + "description": "", "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "ID of SSL certificate", + "description": "list by key, value. Needs to be passed only along with key", "length": 255, - "name": "certid", - "related": "uploadSslCert,listSslCerts", + "name": "value", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "Project that owns the SSL certificate", + "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": "Account ID", + "description": "", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "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 resource type", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" } ], - "related": "uploadSslCert", + "related": "listTags", "response": [ { - "description": "name", - "name": "name", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "SSL certificate ID", - "name": "id", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "certificate fingerprint", - "name": "fingerprint", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - {}, { - "description": "certificate", - "name": "certificate", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "account for the certificate", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -22735,163 +22292,320 @@ "type": "string" }, { - "description": "certificate chain", - "name": "certchain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, + {}, + {}, { - "description": "the project name of the certificate", - "name": "project", + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "since": "4.2" + }, + { + "description": "Attempts to live patch systemVMs - CPVM, SSVM ", + "isasync": true, + "name": "patchSystemVm", + "params": [ + { + "description": "If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, + { + "description": "patches systemVM - CPVM/SSVM with the specified ID", + "length": 255, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": false, + "type": "uuid" + } + ], + "response": [ + { + "description": "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" }, { - "description": "List private gateways", + "description": "Creates a network offering.", "isasync": false, - "name": "listPrivateGateways", + "name": "createNetworkOffering", "params": [ { - "description": "list gateways by vlan", + "description": "desired service capabilities as part of network offering", "length": 255, - "name": "vlan", + "name": "servicecapabilitylist", "required": false, - "type": "string" + "type": "map" }, { - "description": "list gateways by state", + "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": "state", + "name": "serviceproviderlist", "required": false, - "type": "string" + "type": "map" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "true if network offering is meant to be used for VPC, false otherwise.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "forvpc", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "maximum number of concurrent connections supported by the network offering", "length": 255, - "name": "account", + "name": "maxconnections", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "the service offering ID used by virtual router provider", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, "type": "uuid" }, { - "description": "list gateways by ip address", + "description": "set to true if the offering is to be enabled during creation. Default is false", "length": 255, - "name": "ipaddress", + "name": "enable", "required": false, - "type": "string" + "since": "4.16", + "type": "boolean" }, { - "description": "", + "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", "length": 255, - "name": "pagesize", + "name": "specifyipranges", + "required": false, + "type": "boolean" + }, + { + "description": "data transfer rate in megabits per second allowed", + "length": 255, + "name": "networkrate", "required": false, "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "services supported by the network offering", "length": 255, - "name": "isrecursive", + "name": "supportedservices", + "required": false, + "type": "list" + }, + { + "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", + "length": 255, + "name": "internetprotocol", + "required": false, + "since": "4.17.0", + "type": "string" + }, + { + "description": "the display text of the network offering", + "length": 255, + "name": "displaytext", + "required": true, + "type": "string" + }, + { + "description": "the traffic type for the network offering. Supported type in current release is GUEST only", + "length": 255, + "name": "traffictype", + "required": true, + "type": "string" + }, + { + "description": "guest type of the network offering: Shared or Isolated", + "length": 255, + "name": "guestiptype", + "required": true, + "type": "string" + }, + { + "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", + "length": 255, + "name": "fortungsten", "required": false, "type": "boolean" }, { - "description": "", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "since": "4.13", + "type": "list" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "true if the network offering is IP conserve mode enabled", "length": 255, - "name": "listall", + "name": "conservemode", "required": false, "type": "boolean" }, { - "description": "list gateways by vpc", + "description": "true if network offering supports vlans", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "specifyvlan", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "list" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "length": 255, + "name": "egressdefaultpolicy", + "required": false, + "type": "boolean" + }, + { + "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "length": 255, + "name": "ispersistent", + "required": false, + "type": "boolean" + }, + { + "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 availability of network offering. Default value is Optional", + "length": 255, + "name": "availability", "required": false, "type": "string" }, { - "description": "list private gateway by id", + "description": "the name of the network offering", "length": 255, - "name": "id", - "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "length": 255, + "name": "keepaliveenabled", + "required": false, + "type": "boolean" } ], - "related": "createPrivateGateway,createPrivateGateway", + "related": "listNetworkOfferings", "response": [ { - "description": "the project name of the private gateway", - "name": "project", + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" }, { - "description": "Souce Nat enable status", - "name": "sourcenatsupported", - "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": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", - "type": "string" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "the date this network offering was created", + "name": "created", + "type": "date" + }, + { + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" + }, + { + "description": "the id of the network offering", + "name": "id", "type": "string" }, { @@ -22900,255 +22614,430 @@ "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", - "type": "string" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", - "type": "string" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the gateway", - "name": "gateway", - "type": "string" + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", - "type": "string" + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" }, - {}, - {}, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "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 private gateway", - "name": "id", - "type": "string" + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" + }, + { + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" - } - ] + }, + {} + ], + "since": "3.0.0" }, { - "description": "Update the default Ip of a VM Nic", + "description": "Dedicate an existing cluster", "isasync": true, - "name": "updateVmNicIp", + "name": "dedicateCluster", "params": [ { - "description": "Secondary IP Address", + "description": "the ID of the Cluster", "length": 255, - "name": "ipaddress", + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "the ID of the nic to which you want to assign private IP", + "description": "the ID of the containing domain", "length": 255, - "name": "nicid", - "related": "listNics", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": true, "type": "uuid" } ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "related": "listDedicatedClusters", "response": [ { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the domain ID of the cluster", + "name": "domainid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the name of the cluster", + "name": "clustername", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" }, {}, + {}, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the Account ID of the cluster", + "name": "accountid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the cluster", + "name": "clusterid", "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": "Creates an IP forwarding rule", + "isasync": true, + "name": "createIpForwardingRule", + "params": [ + { + "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "the start port for the rule", + "length": 255, + "name": "startport", + "required": true, + "type": "integer" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "the end port for the rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the protocol for the rule. Valid values are TCP or UDP.", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", + "length": 255, + "name": "openfirewall", + "required": false, + "type": "boolean" + } + ], + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "response": [ + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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 ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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": "id of the resource", - "name": "resourceid", + "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" }, { @@ -23157,128 +23046,310 @@ "type": "string" } ], - "type": "set" + "type": "list" }, + {}, { - "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": "Lists volume metrics", + "isasync": false, + "name": "listVolumesMetrics", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "list volumes by disk offering", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the disk volume", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the type of disk volume", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the 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", + "required": false, + "type": "uuid" + }, + { + "description": "the pod id the disk volume belongs to", + "length": 255, + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", + "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": "Guest vm Boot Mode", - "name": "bootmode", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": false, + "type": "uuid" + }, + { + "description": "list volumes on specified host", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + }, + { + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "listsystemvms", + "required": false, + "since": "4.18", + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the IDs of the volumes, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": false, + "since": "4.9", + "type": "list" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, + { + "description": "the cluster id the disk volume belongs to", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "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 display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "displayvolume", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the ID of the storage pool, available to ROOT admin only", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.3", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the 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": "size of the disk volume", + "name": "size", + "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", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "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": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, - {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -23286,8 +23357,33 @@ "type": "integer" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { @@ -23296,196 +23392,291 @@ "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "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": "the list of nics associated with vm", - "name": "nic", + "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": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "disk size in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the nic", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "id of the resource", + "name": "resourceid", "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": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "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": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the ID of 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": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, + { + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" + }, {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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 ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "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": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + } + ], + "since": "4.9.3" + }, + { + "description": "Lists the network Interfaces of elastistor", + "isasync": false, + "name": "listElastistorInterface", + "params": [ + { + "description": "controller id", + "length": 255, + "name": "controllerid", + "required": false, + "type": "string" + } + ], + "related": "listElastistorVolume", + "response": [ + {}, + { + "description": "deduplication", + "name": "deduplication", + "type": "string" + }, + { + "description": "the id of the volume", + "name": "id", + "type": "string" + }, + { + "description": "syncronization", + "name": "sync", "type": "string" }, { @@ -23494,585 +23685,164 @@ "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "compression", + "name": "compression", "type": "string" }, { - "description": "the name of the virtual machine", + "description": "graceallowed", + "name": "graceallowed", + "type": "string" + }, + { + "description": "the name of the volume", "name": "name", "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": "Lists all possible details and their options for a resource type such as a VM or a template", + "isasync": false, + "name": "listDetailOptions", + "params": [ { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the 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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain 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 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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the 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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "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 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" - } - ], - "type": "set" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "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", + "description": "the UUID of the resource (optional)", + "length": 255, + "name": "resourceid", + "required": false, "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the resource type such as UserVm, Template etc.", + "length": 255, + "name": "resourcetype", + "required": true, "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, + } + ], + "related": "", + "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Map of all possible details and their possible list of values", + "name": "details", + "type": "map" }, { - "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 project id of the vm", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - } - ] + {}, + {} + ], + "since": "4.13" }, { - "description": "Updates load balancer stickiness policy", - "isasync": true, - "name": "updateLBStickinessPolicy", + "description": "Lists SSL certificates", + "isasync": false, + "name": "listSslCerts", "params": [ { - "description": "id of lb stickiness policy", + "description": "Load balancer rule ID", "length": 255, - "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", - "required": true, + "name": "lbruleid", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": false, "type": "uuid" }, { - "description": "an optional field, whether to the display the policy to the end user or not", + "description": "Project that owns the SSL certificate", "length": 255, - "name": "fordisplay", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "ID of SSL certificate", "length": 255, - "name": "customid", + "name": "certid", + "related": "uploadSslCert,listSslCerts", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" + }, + { + "description": "Account ID", + "length": 255, + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" } ], - "related": "createLBStickinessPolicy,listLBStickinessPolicies", + "related": "uploadSslCert", "response": [ { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "certificate chain", + "name": "certchain", "type": "string" }, { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "SSL certificate ID", + "name": "id", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name", + "name": "name", "type": "string" }, { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", - "response": [ - { - "description": "the params of the policy", - "name": "params", - "type": "map" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the LB Stickiness policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the method name of the Stickiness policy", - "name": "methodname", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "account for the certificate", + "name": "account", + "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, - {}, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "certificate", + "name": "certificate", + "type": "string" + }, + { + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" + }, + { + "description": "the project name of the certificate", + "name": "project", "type": "string" }, { @@ -24081,23 +23851,26 @@ "type": "integer" }, { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, - { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", - "type": "string" - } - ], - "since": "4.4" + {} + ] }, { - "description": "Lists all Pods.", + "description": "List private gateways", "isasync": false, - "name": "listPods", + "name": "listPrivateGateways", "params": [ + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -24106,1227 +23879,1377 @@ "type": "integer" }, { - "description": "list pods by allocation 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": "allocationstate", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list Pods by name", + "description": "list gateways by state", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, { - "description": "list Pods by ID", + "description": "list private gateway by id", "length": 255, "name": "id", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway", "required": false, "type": "uuid" }, { - "description": "list Pods by Zone ID", + "description": "list gateways by vlan", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "vlan", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "flag to display the capacity of the pods", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "showcapacities", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "List by keyword", + "description": "list gateways by vpc", "length": 255, - "name": "keyword", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "list gateways by ip address", + "length": 255, + "name": "ipaddress", + "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 only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], - "related": "updatePod,createManagementNetworkIpRange", + "related": "createPrivateGateway,createPrivateGateway", "response": [ { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - }, - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - } - ], - "type": "list" + "description": "zone id of the private gateway", + "name": "zoneid", + "type": "string" }, - {}, { - "description": "the ID of the Pod", - "name": "id", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", + "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 account associated with the private gateway", + "name": "account", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + "description": "ACL Id set for private gateway", + "name": "aclid", + "type": "string" + }, { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the Zone name of the Pod", + "description": "the project id of the private gateway", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain associated with the private gateway", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the zone the private gateway belongs to", "name": "zonename", "type": "string" }, { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - } - ], - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the Pod", - "name": "name", + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" + "description": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" + "description": "the private gateway's netmask", + "name": "netmask", + "type": "string" }, - {} + { + "description": "VPC name the private gateway belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the network implementation uri for the private gateway", + "name": "vlan", + "type": "string" + }, + { + "description": "the id of the private gateway", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", + "type": "string" + }, + { + "description": "the gateway", + "name": "gateway", + "type": "string" + } ] }, { - "description": "Starts an existing internal lb vm.", + "description": "Update the default Ip of a VM Nic", "isasync": true, - "name": "startInternalLoadBalancerVM", + "name": "updateVmNicIp", "params": [ { - "description": "the ID of the internal lb vm", + "description": "the ID of the nic to which you want to assign private IP", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "name": "nicid", + "related": "listNics", "required": true, "type": "uuid" + }, + { + "description": "Secondary IP Address", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" } ], - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "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,importUnmanagedInstance", "response": [ { - "description": "the version of template", - "name": "version", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + {}, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the template ID for the router", + "description": "the ID of 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 router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the account owning the affinity group", + "name": "account", "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, + } + ], + "type": "set" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "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": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "tag key name", + "name": "key", "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": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the name of the router", - "name": "name", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, {}, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "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 project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "result of the health check", - "name": "success", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" } ], - "type": "list" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - } - ] - }, - { - "description": "Updates a disk offering.", - "isasync": false, - "name": "updateDiskOffering", - "params": [ - { - "description": "io requests read rate of the disk offering", - "length": 255, - "name": "iopsreadrate", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "sort key of the disk offering, integer", - "length": 255, - "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": "burst io requests write rate of the disk offering", - "length": 255, - "name": "iopswriteratemax", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", - "type": "string" - }, - { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "ID of the disk offering", - "length": 255, - "name": "id", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "the cache mode to use for this disk offering", - "length": 255, - "name": "cachemode", - "required": false, - "since": "4.15", - "type": "string" - }, - { - "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", - "length": 255, - "name": "tags", - "required": false, - "since": "4.15", - "type": "string" - }, - { - "description": "updates name of the disk offering with this value", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopswriteratemaxlength", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "updates alternate display text of the disk offering with this value", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "an optional field, whether to display the offering to the end user or not.", - "length": 255, - "name": "displayoffering", - "required": false, - "type": "boolean" - }, - { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "byteswriteratemaxlength", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "burst bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadratemax", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "bytes write rate of the disk offering", - "length": 255, - "name": "byteswriterate", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "burst requests read rate of the disk offering", - "length": 255, - "name": "iopsreadratemax", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopsreadratemaxlength", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadrate", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "io requests write rate of the disk offering", - "length": 255, - "name": "iopswriterate", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", - "required": false, - "since": "4.13", - "type": "string" - } - ], - "related": "createDiskOffering,listDiskOfferings", - "response": [ - { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "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" + "type": "set" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" - }, - { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" - }, - { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" - }, - {}, - { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" - }, - { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, - { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", - "type": "string" + "description": "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 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 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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the 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 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 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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "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": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "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" + } + ], + "type": "set" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "unique ID of the disk offering", - "name": "id", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "the group ID of the virtual machine", + "name": "groupid", "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the 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 vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "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 name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" - } - ] - }, - { - "description": " delete a SRX firewall device", - "isasync": true, - "name": "deleteSrxFirewall", - "params": [ - { - "description": "srx firewall device ID", - "length": 255, - "name": "fwdeviceid", - "related": "configureSrxFirewall", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Stops a running Kubernetes cluster", - "isasync": true, - "name": "stopKubernetesCluster", - "params": [ - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, { - "description": "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": "any text associated with the success or failure", - "name": "displaytext", + "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": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" } ] }, { - "description": "Adds account to a project", + "description": "Updates load balancer stickiness policy", "isasync": true, - "name": "addAccountToProject", + "name": "updateLBStickinessPolicy", "params": [ { - "description": "email to which invitation to the project is going to be sent", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "email", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "ID of the project to add the account to", + "description": "id of lb stickiness policy", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", "required": true, "type": "uuid" }, { - "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", + "description": "an optional field, whether to the display the policy to the end user or not", "length": 255, - "name": "roletype", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" + } + ], + "related": "createLBStickinessPolicy,listLBStickinessPolicies", + "response": [ + {}, + { + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", + "response": [ + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "the LB Stickiness policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the params of the policy", + "name": "params", + "type": "map" + }, + { + "description": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + } + ], + "type": "list" }, { - "description": "name of the account to be added to the project", - "length": 255, - "name": "account", - "required": false, + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "the domain ID of the Stickiness policy", + "name": "domainid", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the domain of the Stickiness policy", + "name": "domain", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" }, {}, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" } ], - "since": "3.0.0" + "since": "4.4" }, { - "description": "Lists all available snapshots for the account.", + "description": "Lists all Pods.", "isasync": false, - "name": "listSnapshots", + "name": "listPods", "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 objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -25334,14 +25257,6 @@ "required": false, "type": "integer" }, - { - "description": "list snapshots by zone id", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -25350,254 +25265,221 @@ "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "lists snapshot by snapshot name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "valid values are MANUAL or RECURRING.", + "description": "", "length": 255, - "name": "snapshottype", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "lists snapshot by snapshot ID", + "description": "list Pods by Zone ID", "length": 255, - "name": "id", - "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list pods by allocation state", "length": 255, - "name": "account", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "description": "list Pods by name", "length": 255, - "name": "intervaltype", + "name": "name", "required": false, "type": "string" }, { - "description": "the IDs of the snapshots, mutually exclusive with id", + "description": "flag to display the capacity of the pods", "length": 255, - "name": "ids", - "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", + "name": "showcapacities", "required": false, - "since": "4.9", - "type": "list" + "type": "boolean" }, { - "description": "the ID of the disk volume", + "description": "list Pods by 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", + "name": "id", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" } ], - "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot", + "related": "updatePod,createManagementNetworkIpRange", "response": [ { - "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": "display name of the os on volume", - "name": "osdisplayname", + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, - {}, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" }, { - "description": "ID of the snapshot", - "name": "id", - "type": "string" + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" }, + {}, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the name of the Pod", + "name": "name", + "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 domain name of the snapshot's account", - "name": "domain", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", + "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": "the starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + } + ], + "type": "list" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the ID of the Pod", + "name": "id", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the capacity of the Pod", + "name": "capacity", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "tag value", - "name": "value", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "tag key name", - "name": "key", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the Pod ID", + "name": "podid", "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" } ], - "type": "set" - }, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" - }, - { - "description": "id of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" - }, - { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" - }, - {}, - { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" - }, - { - "description": "name of the snapshot", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" - }, - { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" - }, - { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" + "type": "list" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { @@ -25608,893 +25490,979 @@ ] }, { - "description": "Reset site to site vpn connection", + "description": "Starts an existing internal lb vm.", "isasync": true, - "name": "resetVpnConnection", + "name": "startInternalLoadBalancerVM", "params": [ { - "description": "an optional account for connection. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "id of vpn connection", + "description": "the ID of the internal lb vm", "length": 255, "name": "id", - "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", + "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": true, "type": "uuid" - }, - { - "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" } ], - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the domain id of the owner", + "description": "the domain ID associated with the router", "name": "domainid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "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 second DNS for the router", + "name": "dns2", + "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, - {}, { - "description": "the project id", - "name": "projectid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, - {}, { - "description": "the connection ID", - "name": "id", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "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 version of template", + "name": "version", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, + {}, { - "description": "the owner", - "name": "account", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "role of the domain router", + "name": "role", "type": "string" - } - ] - }, - { - "description": "Lists Kubernetes clusters", - "isasync": false, - "name": "listKubernetesClusters", - "params": [ - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": false, - "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the public netmask for the router", + "name": "publicnetmask", "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": "state of the Kubernetes cluster", - "length": 255, - "name": "state", - "required": false, + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", - "length": 255, - "name": "name", - "required": false, + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "response": [ - { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "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": "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 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": "macaddress", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the 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": "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": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the project name of the address", + "name": "project", "type": "string" }, - {}, { - "description": "the id of the Kubernetes cluster", + "description": "the id of the router", "name": "id", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "type": "string" - }, - { - "description": "keypair details", - "name": "keypair", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" - }, - { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" - }, - { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "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", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the Kubernetes cluster", + "description": "the name of the router", "name": "name", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "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 host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "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", "type": "string" - }, - { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" - }, - { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" - }, - { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" } ] }, { - "description": "Deletes a keypair by name", + "description": "Updates a disk offering.", "isasync": false, - "name": "deleteSSHKeyPair", + "name": "updateDiskOffering", "params": [ { - "description": "the account associated with the keypair. Must be used with the domainId parameter.", + "description": "sort key of the disk offering, integer", "length": 255, - "name": "account", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the domain ID associated with the keypair", - "length": 255, + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "uuid" + "since": "4.13", + "type": "string" }, { - "description": "the project associated with keypair", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "iopswriterate", "required": false, - "type": "uuid" + "since": "4.15", + "type": "long" }, { - "description": "Name of the keypair", + "description": "length (in seconds) of the burst", "length": 255, - "name": "name", - "required": true, - "type": "string" - } - ], - "response": [ - {}, + "name": "iopswriteratemaxlength", + "required": false, + "since": "4.15", + "type": "long" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", + "required": false, + "since": "4.15", + "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "length": 255, + "name": "tags", + "required": false, + "since": "4.15", + "type": "string" }, { - "description": "any text associated with the success or failure", + "description": "updates alternate display text of the disk offering with this value", + "length": 4096, "name": "displaytext", + "required": false, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", - "isasync": true, - "name": "createAutoScaleVmGroup", - "params": [ + "description": "ID of the disk offering", + "length": 255, + "name": "id", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" + }, { - "description": "the frequency at which the conditions have to be evaluated", + "description": "length (in seconds) of the burst", "length": 255, - "name": "interval", + "name": "iopsreadratemaxlength", "required": false, - "type": "integer" + "since": "4.15", + "type": "long" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "maxmembers", - "required": true, - "type": "integer" + "name": "iopsreadratemax", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "list of scaleup autoscale policies", + "description": "length (in seconds) of the burst", "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "list" + "name": "byteswriteratemaxlength", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "list of scaledown autoscale policies", + "description": "updates name of the disk offering with this value", "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "list" + "name": "name", + "required": false, + "type": "string" }, { - "description": "the ID of the load balancer rule", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" + "name": "bytesreadratemax", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" + "name": "iopswriteratemax", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, - "name": "minmembers", - "required": true, - "type": "integer" + "name": "zoneid", + "required": false, + "since": "4.13", + "type": "string" }, { - "description": "an optional field, whether to the display the group to the end user or not", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "fordisplay", + "name": "byteswriteratemax", "required": false, - "since": "4.4", - "type": "boolean" - } - ], - "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "response": [ + "since": "4.15", + "type": "long" + }, { - "description": "is group for display to the regular user", - "name": "fordisplay", + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "an optional field, whether to display the offering to the end user or not.", + "length": 255, + "name": "displayoffering", + "required": false, "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadrate", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the cache mode to use for this disk offering", + "length": 255, + "name": "cachemode", + "required": false, + "since": "4.15", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" + "description": "io requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", + "required": false, + "since": "4.15", + "type": "long" + } + ], + "related": "createDiskOffering,listDiskOfferings", + "response": [ + { + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, - {}, - {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", - "type": "string" + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "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": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" + }, + { + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - } - ] - }, - { - "description": "Searches LDAP based on the username attribute", - "isasync": false, - "name": "searchLdap", - "params": [ + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "query to search using", - "length": 255, - "name": "query", - "related": "searchLdap,listLdapUsers", - "required": true, - "type": "string" - } - ], - "related": "listLdapUsers", - "response": [ + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "The user's email", - "name": "email", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, + { + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "The user's domain", - "name": "domain", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "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 user's principle", - "name": "principal", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "The user's username", - "name": "username", + "description": "the name of the disk offering", + "name": "name", "type": "string" }, { - "description": "The user's lastname", - "name": "lastname", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "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": "an alternate display text of the disk offering.", + "name": "displaytext", "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 domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" - } - ], - "since": "4.2.0" + }, + { + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" + }, + {} + ] }, { - "description": "Deletes a load balancer rule.", + "description": "delete Tungsten-Fabric address group", "isasync": true, - "name": "deleteLoadBalancerRule", + "name": "deleteTungstenFabricAddressGroup", "params": [ { - "description": "the ID of the load balancer rule", + "description": "the uuid of Tungsten-Fabric address group", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "addressgroupuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" } ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "add a baremetal ping pxe server", + "description": "Stops a running Kubernetes cluster", "isasync": true, - "name": "addBaremetalPxePingServer", + "name": "stopKubernetesCluster", "params": [ { - "description": "PING storage server ip", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "pingstorageserverip", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "Root directory on PING storage server", - "length": 255, - "name": "pingdir", - "required": true, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Pod Id", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "username", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Adds account to a project", + "isasync": true, + "name": "addAccountToProject", + "params": [ { - "description": "Credentials to reach external pxe device", + "description": "name of the account to be added to the project", "length": 255, - "name": "password", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "URL of the external pxe device", + "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", "length": 255, - "name": "url", - "required": true, + "name": "roletype", + "required": false, "type": "string" }, { - "description": "Tftp root directory of PXE server", + "description": "ID of the project to add the account to", "length": 255, - "name": "tftpdir", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Password of PING storage server", + "description": "email to which invitation to the project is going to be sent", "length": 255, - "name": "pingcifspassword", + "name": "email", "required": false, "type": "string" }, { - "description": "Username of PING storage server", + "description": "ID of the project role", "length": 255, - "name": "pingcifsusername", + "name": "projectroleid", + "related": "createProjectRole,listProjectRoles,updateProjectRole", "required": false, - "type": "string" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, "type": "uuid" - }, - { - "description": "type of pxe device", - "length": 255, - "name": "pxeservertype", - "required": true, - "type": "string" } ], - "related": "", "response": [ { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "Root directory on PING storage server", - "name": "pingdir", - "type": "string" + "description": "the 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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -26503,53 +26471,40 @@ }, {}, { - "description": "url", - "name": "url", - "type": "string" - }, - { - "description": "PING storage server ip", - "name": "pingstorageserverip", - "type": "string" - }, - { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "device id of ", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "list portable IP ranges", + "description": "Lists all available snapshots for the account.", "isasync": false, - "name": "listPortableIpRanges", + "name": "listSnapshots", "params": [ { - "description": "List by keyword", + "description": "valid values are MANUAL or RECURRING.", "length": 255, - "name": "keyword", + "name": "snapshottype", "required": false, "type": "string" }, { - "description": "Id of the portable ip range", + "description": "the ID of the disk volume", "length": 255, - "name": "id", - "related": "createPortableIpRange,listPortableIpRanges", + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "type": "uuid" }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, { "description": "", "length": 255, @@ -26558,11 +26513,19 @@ "type": "integer" }, { - "description": "Id of a Region", + "description": "lists snapshot by snapshot ID", "length": 255, - "name": "regionid", + "name": "id", + "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", "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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { "description": "", @@ -26570,575 +26533,612 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "list snapshots by zone id", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "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": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "lists snapshot by snapshot name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "the IDs of the snapshots, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", + "required": false, + "since": "4.9", + "type": "list" + }, + { + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "length": 255, + "name": "intervaltype", + "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": "createPortableIpRange", + "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot", "response": [ { - "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", - "name": "portableipaddress", + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" } ], - "type": "list" + "type": "set" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the snapshot", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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", "type": "string" }, - {}, { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", - "type": "integer" + "description": "name of the snapshot", + "name": "name", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" }, { - "description": "the start ip of the portable IP range", - "name": "startip", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "portable IP range ID", - "name": "id", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, {}, { - "description": "the end ip of the portable IP range", - "name": "endip", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", "type": "string" } ] }, { - "description": "Returns user data associated with the VM", - "isasync": false, - "name": "getVirtualMachineUserData", + "description": "delete Tungsten-Fabric logical router", + "isasync": true, + "name": "deleteTungstenFabricLogicalRouter", "params": [ { - "description": "The ID of the virtual machine", + "description": "the ID of zone", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric logical router", + "length": 255, + "name": "logicalrouteruuid", + "required": true, + "type": "string" } ], - "related": "", "response": [ { "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": "virtualmachineid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Base 64 encoded VM user data", - "name": "userdata", + "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.4" + ] }, { - "description": "Updates network permissions.", - "isasync": false, - "name": "createNetworkPermissions", + "description": "Reset site to site vpn connection", + "isasync": true, + "name": "resetVpnConnection", "params": [ { - "description": "the network ID", + "description": "id of vpn connection", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", "required": true, "type": "uuid" }, { - "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "accountids", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,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.", + "description": "an optional account for connection. Must be used with domainId.", "length": 255, - "name": "accounts", + "name": "account", "required": false, - "type": "list" + "type": "string" }, { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "list" + "type": "uuid" } ], + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "response": [ { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "State of vpn connection", + "name": "state", + "type": "string" }, - {} - ], - "since": "4.17.0" - }, - { - "description": "Lists all configurations.", - "isasync": false, - "name": "listConfigurations", - "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", - "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" + "description": "the project name", + "name": "project", + "type": "string" }, { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", - "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": false, - "type": "uuid" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "lists configuration by name", - "length": 255, - "name": "name", - "required": false, + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "lists configurations by category", - "length": 255, - "name": "category", - "required": false, + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "the ID of the Domain to update the parameter value for corresponding domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" }, { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "updateConfiguration", - "response": [ - { - "description": "the description of the configuration", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the value of the configuration", - "name": "id", - "type": "long" + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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 project id", + "name": "projectid", "type": "string" }, { - "description": "the name of the configuration", - "name": "name", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", + "description": "State of vpn connection", + "name": "passive", "type": "boolean" }, { - "description": "the category of the configuration", - "name": "category", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", - "type": "string" - } - ] - }, - { - "description": "Disables static rule for given IP address", - "isasync": true, - "name": "disableStaticNat", - "params": [ - { - "description": "the public IP address ID for which static NAT feature is being disabled", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - {}, + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { - "description": "Assigns secondary IP to NIC", - "isasync": true, - "name": "addIpToNic", + "description": "Lists Kubernetes clusters", + "isasync": false, + "name": "listKubernetesClusters", "params": [ { - "description": "the ID of the nic to which you want to assign private IP", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "nicid", - "related": "listNics", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, "type": "uuid" }, { - "description": "Secondary 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" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the ID of the network", - "name": "networkid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Secondary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the secondary private IP addr", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "nicid", - "type": "string" - }, - { - "description": "the list of Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the Kubernetes cluster", + "length": 255, + "name": "state", + "required": false, "type": "string" }, - { - "description": "the ID of the vm", - "name": "virtualmachineid", - "type": "string" - } - ] - }, - { - "description": "Scales a created, running or stopped Kubernetes cluster", - "isasync": true, - "name": "scaleKubernetesCluster", - "params": [ { "description": "the ID of the Kubernetes cluster", "length": 255, "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": false, "type": "uuid" }, { - "description": "the IDs of the nodes to be removed", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "nodeids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "isrecursive", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "number of Kubernetes cluster nodes", + "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": "size", + "name": "name", "required": false, - "type": "long" + "type": "string" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "Maximum number of worker nodes in the cluster", + "description": "", "length": 255, - "name": "maxsize", + "name": "page", "required": false, - "type": "long" + "type": "integer" }, { - "description": "Whether autoscaling is enabled for the cluster", + "description": "List by keyword", "length": 255, - "name": "autoscalingenabled", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Minimum number of worker nodes in the cluster", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "minsize", + "name": "account", "required": false, - "type": "long" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "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", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the memory the Kubernetes cluster", + "name": "memory", "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 service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { @@ -27147,14 +27147,24 @@ "type": "list" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" }, { "description": "the cpu cores of the Kubernetes cluster", @@ -27162,28 +27172,48 @@ "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "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 name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Public IP Address of the cluster", "name": "ipaddress", "type": "string" }, { - "description": "the 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", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { @@ -27192,40 +27222,40 @@ "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "keypair details", + "name": "keypair", "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": "Whether autoscaling is enabled for the cluster", "name": "autoscalingenabled", "type": "boolean" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, + {}, { - "description": "the name of the Kubernetes cluster", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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 control nodes count for the Kubernetes cluster", @@ -27233,752 +27263,780 @@ "type": "long" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" - }, + } + ] + }, + { + "description": "Deletes a keypair by name", + "isasync": false, + "name": "deleteSSHKeyPair", + "params": [ { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the domain ID associated with the keypair", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project associated with keypair", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "keypair details", - "name": "keypair", + "description": "the account associated with the keypair. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Stops a NetScalervm.", + "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", "isasync": true, - "name": "stopNetScalerVpx", + "name": "createAutoScaleVmGroup", "params": [ { - "description": "Force stop the VM. The caller knows the VM is stopped.", + "description": "the name of the autoscale vmgroup", "length": 255, - "name": "forced", + "name": "name", "required": false, - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "description": "the ID of the NetScaler vm", + "description": "the frequency in which the performance counters to be collected", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "name": "interval", + "required": false, + "type": "integer" + }, + { + "description": "list of scaledown autoscale policies", + "length": 255, + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "list" + }, + { + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "length": 255, + "name": "minmembers", + "required": true, + "type": "integer" + }, + { + "description": "the autoscale profile that contains information about the vms in the vm group.", + "length": 255, + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, + "type": "uuid" + }, + { + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "length": 255, + "name": "maxmembers", + "required": true, + "type": "integer" + }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" + }, + { + "description": "an optional field, whether to the display the group to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "list of scaleup autoscale policies", + "length": 255, + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "list" } ], - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the hostname for the router", - "name": "hostname", + "description": "the current status of the latest async job acting 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 nics associated with the router", - "name": "nic", - "response": [ - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - } - ], - "type": "set" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the id of the router", - "name": "id", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the domain name of the vm group", + "name": "domain", + "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "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", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" + }, + { + "description": "the private port", + "name": "privateport", "type": "string" }, - {}, { - "description": "the template name for the router", - "name": "templatename", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "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": "role of the domain router", - "name": "role", + "description": "the public port", + "name": "publicport", "type": "string" }, + {}, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" - }, + } + ] + }, + { + "description": "Searches LDAP based on the username attribute", + "isasync": false, + "name": "searchLdap", + "params": [ { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "query to search using", + "length": 255, + "name": "query", + "related": "searchLdap,listLdapUsers", + "required": true, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the router", - "name": "name", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, - {}, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "listLdapUsers", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "The user's email", + "name": "email", + "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "The user's principle", + "name": "principal", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "The user's lastname", + "name": "lastname", "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 user's username", + "name": "username", + "type": "string" }, + {}, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "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 domain associated with the router", + "description": "The user's domain", "name": "domain", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "Deletes a load balancer rule.", + "isasync": true, + "name": "deleteLoadBalancerRule", + "params": [ + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "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": "VPC the router belongs to", - "name": "vpcid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "add a baremetal ping pxe server", + "isasync": true, + "name": "addBaremetalPxePingServer", + "params": [ + { + "description": "type of pxe device", + "length": 255, + "name": "pxeservertype", + "required": true, "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "Username of PING storage server", + "length": 255, + "name": "pingcifsusername", + "required": false, "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "PING storage server ip", + "length": 255, + "name": "pingstorageserverip", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,updatePhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "Password of PING storage server", + "length": 255, + "name": "pingcifspassword", + "required": false, "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "Root directory on PING storage server", + "length": 255, + "name": "pingdir", + "required": true, "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "Pod Id", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "URL of the external pxe device", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "Tftp root directory of PXE server", + "length": 255, + "name": "tftpdir", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "Root directory on PING storage server", + "name": "pingdir", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the address", - "name": "project", + "description": "url", + "name": "url", "type": "string" }, + {}, { - "description": "the template ID for the router", - "name": "templateid", + "description": "PING storage server ip", + "name": "pingstorageserverip", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Delete a Ucs manager", - "isasync": false, - "name": "deleteUcsManager", + "description": "create Tungsten-Fabric logical router", + "isasync": true, + "name": "createTungstenFabricLogicalRouter", "params": [ { - "description": "ucs manager id", + "description": "the ID of zone", "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric logical router name", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], + "related": "addTungstenFabricNetworkGatewayToLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "type": "string" }, + {}, { "description": "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "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": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + { + "description": "Tungsten-Fabric logical router name", + "name": "name", "type": "string" } ] }, { - "description": "Deletes a host.", - "isasync": false, - "name": "deleteHost", + "description": "create Tungsten-Fabric firewall", + "isasync": true, + "name": "createTungstenFabricFirewallRule", "params": [ { - "description": "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped", + "description": "the ID of zone", "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the host ID", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "name": "firewallpolicyuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", + "description": "Tungsten-Fabric firewall rule tag type uuid", "length": 255, - "name": "forcedestroylocalstorage", + "name": "tagtypeuuid", "required": false, - "type": "boolean" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the uuid of Tungsten-Fabric destination network", + "length": 255, + "name": "destnetworkuuid", + "required": false, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Tungsten-Fabric firewall rule source address group uuid", + "length": 255, + "name": "srcaddressgroupuuid", + "required": false, + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric firewall rule action", + "length": 255, + "name": "action", + "required": true, + "type": "string" }, - {} - ] - }, - { - "description": "Deletes a vm group", - "isasync": false, - "name": "deleteInstanceGroup", - "params": [ { - "description": "the ID of the instance group", + "description": "Tungsten-Fabric firewall rule direction", "length": 255, - "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "name": "direction", "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the sequence of Tungsten-Fabric firewall rule", + "length": 255, + "name": "sequence", + "required": true, "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric firewall rule source tag uuid", + "length": 255, + "name": "srctaguuid", + "required": false, "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Tungsten-Fabric firewall rule destination tag uuid", + "length": 255, + "name": "desttaguuid", + "required": false, "type": "string" }, - {} - ] - }, - { - "description": "deletes the resource icon from the specified resource(s)", - "isasync": false, - "name": "deleteResourceIcon", - "params": [ { - "description": "list of resources to upload the icon/image for", + "description": "Tungsten-Fabric firewall rule destination address group uuid", "length": 255, - "name": "resourceids", - "required": true, - "type": "list" + "name": "destaddressgroupuuid", + "required": false, + "type": "string" }, { - "description": "type of the resource", + "description": "Tungsten-Fabric firewall rule service group uuid", "length": 255, - "name": "resourcetype", + "name": "servicegroupuuid", "required": true, "type": "string" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Tungsten-Fabric firewall rule name", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the uuid of Tungsten-Fabric source network", + "length": 255, + "name": "srcnetworkuuid", + "required": false, "type": "string" - }, - {}, - {} + } ], - "since": "4.16.0.0" - }, - { - "description": "Lists capabilities", - "isasync": false, - "name": "listCapabilities", - "params": [], - "related": "", + "related": "listTungstenFabricFirewallRule", "response": [ { - "description": "true if snapshot is supported for KVM host, false otherwise", - "name": "kvmsnapshotenabled", - "type": "boolean" + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", + "type": "string" }, { - "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", - "name": "kubernetesclusterexperimentalfeaturesenabled", - "type": "boolean" + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", + "type": "string" }, { - "description": "true if regular user is allowed to create projects", - "name": "allowusercreateprojects", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "default page size in the UI for various views, value set in the configurations", - "name": "defaultuipagesize", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, + {}, { - "description": "true if the user can recover and expunge volumes, false otherwise", - "name": "allowuserexpungerecovervolume", - "type": "boolean" - }, - { - "description": "minimum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingminsize", - "type": "long" + "description": "Tungsten-Fabric firewall rule name", + "name": "name", + "type": "string" }, - {}, { - "description": "Max allowed number of api requests within the specified interval", - "name": "apilimitmax", - "type": "integer" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, { - "description": "true if Kubernetes Service plugin is enabled, false otherwise", - "name": "kubernetesserviceenabled", - "type": "boolean" + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", + "type": "string" }, { - "description": "true if region wide secondary is enabled, false otherwise", - "name": "regionsecondaryenabled", - "type": "boolean" + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", + "type": "string" }, { - "description": "time interval (in seconds) to reset api count", - "name": "apilimitinterval", - "type": "integer" + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", + "type": "string" }, { - "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", - "type": "boolean" + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -27986,216 +28044,315 @@ "type": "integer" }, { - "description": "version of the cloud stack", - "name": "cloudstackversion", + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", "type": "string" }, + {}, { - "description": "maximum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingmaxsize", - "type": "long" - }, - { - "description": "true if region supports elastic load balancer on basic zones", - "name": "supportELB", + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", "type": "string" }, { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", - "type": "boolean" - }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, { - "description": "true if the user can recover and expunge virtualmachines, false otherwise", - "name": "allowuserexpungerecovervm", - "type": "boolean" - }, - { - "description": "true if user and domain admins can set templates to be shared, false otherwise", - "name": "userpublictemplateenabled", - "type": "boolean" - }, - { - "description": "true if users can see all accounts within the same domain, false otherwise", - "name": "allowuserviewalldomainaccounts", - "type": "boolean" + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", + "type": "string" }, { - "description": "true if dynamic role-based api checker is enabled, false otherwise", - "name": "dynamicrolesenabled", - "type": "boolean" - }, - {} + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", + "type": "string" + } ] }, { - "description": "Updates traffic type of a physical network", - "isasync": true, - "name": "updateTrafficType", + "description": "list portable IP ranges", + "isasync": false, + "name": "listPortableIpRanges", "params": [ { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "description": "", "length": 255, - "name": "hypervnetworklabel", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "Id of the portable ip range", "length": 255, - "name": "kvmnetworklabel", + "name": "id", + "related": "createPortableIpRange,listPortableIpRanges", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "List by keyword", "length": 255, - "name": "ovm3networklabel", + "name": "keyword", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "description": "Id of a Region", "length": 255, - "name": "vmwarenetworklabel", + "name": "regionid", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "", "length": 255, - "name": "xennetworklabel", + "name": "page", "required": false, - "type": "string" - }, - { - "description": "traffic type id", - "length": 255, - "name": "id", - "related": "addTrafficType,updateTrafficType", - "required": true, - "type": "uuid" + "type": "integer" } ], - "related": "addTrafficType", + "related": "createPortableIpRange", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the end ip of the portable IP range", + "name": "endip", "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "portable IP range ID", + "name": "id", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of the network provider", - "name": "id", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", + "name": "portableipaddress", + "response": [ + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "VPC the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "the account ID the portable IP address is associated with", + "name": "accountid", + "type": "string" + }, + { + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", + "type": "string" + } + ], + "type": "list" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", + "description": "the start ip of the portable IP range", + "name": "startip", "type": "string" }, {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" + } + ] + }, + { + "description": "Returns user data associated with the VM", + "isasync": false, + "name": "getVirtualMachineUserData", + "params": [ + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "Base 64 encoded VM user data", + "name": "userdata", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "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": "virtualmachineid", "type": "string" }, + {}, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], - "since": "3.0.0" + "since": "4.4" }, { - "description": "Release dedication of zone", - "isasync": true, - "name": "releaseDedicatedZone", + "description": "Updates network permissions.", + "isasync": false, + "name": "createNetworkPermissions", "params": [ { - "description": "the ID of the Zone", + "description": "the network ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "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, + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "list" + }, + { + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accountids", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "list" + }, + { + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accounts", + "required": false, + "type": "list" } ], "response": [ - { - "description": "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" } - ] + ], + "since": "4.17.0" }, { - "description": "List Conditions for the specific user", + "description": "Lists all configurations.", "isasync": false, - "name": "listConditions", + "name": "listConfigurations", "params": [ { - "description": "Counter-id of the condition.", + "description": "lists configurations by category", "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", + "name": "category", + "required": false, + "type": "string" + }, + { + "description": "the ID of the Domain to update the parameter value for corresponding domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, + { + "description": "lists configuration by group name (primarily used for UI)", + "length": 255, + "name": "group", + "required": false, + "since": "4.18.0", + "type": "string" + }, { "description": "List by keyword", "length": 255, @@ -28204,49 +28361,67 @@ "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 configuration by subgroup name (primarily used for UI)", "length": 255, - "name": "listall", + "name": "subgroup", "required": false, - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "description": "ID of the Condition.", + "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "id", - "related": "createCondition,listConditions", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "the ID of the policy", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "lists configuration 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.", + "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, - "name": "isrecursive", + "name": "imagestoreuuid", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "the ID of the Account to update the parameter value for corresponding account", + "length": 255, + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "lists configuration by parent name (primarily used for UI)", + "length": 255, + "name": "parent", + "required": false, + "since": "4.18.0", + "type": "string" }, { "description": "", @@ -28263,43 +28438,73 @@ "type": "integer" } ], - "related": "createCondition", + "related": "updateConfiguration", "response": [ { - "description": "the owner of the Condition.", - "name": "account", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "the category of the configuration", + "name": "category", + "type": "string" + }, + { + "description": "the type of the configuration value", + "name": "type", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" + }, + { + "description": "the component of the configuration", + "name": "component", + "type": "string" + }, + { + "description": "the description of the configuration", + "name": "description", "type": "string" }, {}, { - "description": "Threshold Value for the counter.", - "name": "threshold", + "description": "the value of the configuration", + "name": "id", "type": "long" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the display text of the configuration", + "name": "displaytext", + "type": "string" + }, + { + "description": "the name of the configuration", + "name": "name", "type": "string" }, {}, { - "description": "the project id of the Condition.", - "name": "projectid", + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { @@ -28308,504 +28513,646 @@ "type": "string" }, { - "description": "the id of the Condition", - "name": "id", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, + { + "description": "the group of the configuration", + "name": "group", + "type": "string" + } + ] + }, + { + "description": "Disables static rule for given IP address", + "isasync": true, + "name": "disableStaticNat", + "params": [ + { + "description": "the public IP address ID for which static NAT feature is being disabled", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "list" + "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": "Updates a network serviceProvider of a physical network", + "description": "Assigns secondary IP to NIC", "isasync": true, - "name": "updateNetworkServiceProvider", + "name": "addIpToNic", "params": [ { - "description": "Enabled/Disabled/Shutdown the physical network service provider", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "network service provider id", + "description": "the ID of the nic to which you want to assign private IP", "length": 255, - "name": "id", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "name": "nicid", + "related": "listNics", "required": true, "type": "uuid" }, { - "description": "the list of services to be enabled for this physical network service provider", + "description": "Secondary IP Address", "length": 255, - "name": "servicelist", + "name": "ipaddress", "required": false, - "type": "list" + "type": "string" } ], - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "related": "", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "Secondary IP address", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the provider name", - "name": "name", + "description": "the ID of the nic", + "name": "nicid", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the ID of the secondary private IP addr", + "name": "id", "type": "string" }, {}, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the ID of the vm", + "name": "virtualmachineid", + "type": "string" }, - {}, { - "description": "uuid of the network provider", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", + "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": "state of the network provider", - "name": "state", + "description": "the ID of the network", + "name": "networkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists Management Server metrics", - "isasync": false, - "name": "listManagementServersMetrics", + "description": "Scales a created, running or stopped Kubernetes cluster", + "isasync": true, + "name": "scaleKubernetesCluster", "params": [ { - "description": "include system level stats", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "system", - "related": "listManagementServersMetrics", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "number of Kubernetes cluster nodes", "length": 255, - "name": "page", + "name": "size", "required": false, - "type": "integer" + "type": "long" }, { - "description": "the id of the management server", + "description": "Maximum number of worker nodes in the cluster", "length": 255, - "name": "id", - "related": "listManagementServers", + "name": "maxsize", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "the name of the management server", + "description": "Minimum number of worker nodes in the cluster", "length": 255, - "name": "name", + "name": "minsize", "required": false, - "type": "string" + "type": "long" }, { - "description": "List by keyword", + "description": "Whether autoscaling is enabled for the cluster", "length": 255, - "name": "keyword", + "name": "autoscalingenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "the IDs of the nodes to be removed", "length": 255, - "name": "pagesize", + "name": "nodeids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "type": "integer" + "type": "list" + }, + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "The number of terminated threads", - "name": "threadsteminatedcount", - "type": "integer" - }, - { - "description": "the amount of memory allocated to this Management Server", - "name": "heapmemorytotal", - "type": "long" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", + "description": "the ID of the network of the Kubernetes cluster", + "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 load averages for 1 5 and 15 minutes", - "name": "systemloadaverages", - "type": "double[]" + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" }, {}, { - "description": "The number of threads", - "name": "threadstotalcount", - "type": "integer" - }, - { - "description": "The number of blocked threads", - "name": "threadsblockedcount", - "type": "integer" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, { - "description": "The number of runnable threads", - "name": "threadsrunnablecount", - "type": "integer" + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" }, { - "description": "the number of agents this Management Server is responsible for", - "name": "agentcount", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the management server", - "name": "name", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the ID of the management server", - "name": "id", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the amount of memory used by this Management Server", - "name": "heapmemoryused", + "description": "Maximum size of the cluster", + "name": "maxsize", "type": "long" }, { - "description": "the log files and their usage on disk", - "name": "loginfo", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, { - "description": "the current cpu load", - "name": "cpuload", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "Virtual size of the fully loaded process", - "name": "systemmemoryvirtualsize", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the number of client sessions active on this Management Server", - "name": "sessions", - "type": "long" + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" }, { - "description": "Amount of memory used", - "name": "systemmemoryused", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the system is running against a local database", - "name": "dbislocal", - "type": "boolean" + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "Free system memory", - "name": "systemmemoryfree", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "The number of daemon threads", - "name": "threadsdaemoncount", - "type": "integer" + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "type": "date" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the version of the management server", - "name": "version", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the system has a usage server running locally", - "name": "usageislocal", - "type": "boolean" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, {}, { - "description": "the system load for user, and system processes and the system idle cycles", - "name": "systemcycleusage", - "type": "long[]" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" }, { - "description": "Total system memory", - "name": "systemmemorytotal", + "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": "the total system cpu capacity", - "name": "systemtotalcpucycles", - "type": "double" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "The number of waiting threads", - "name": "threadswaitingcount", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the number of processors available to the JVM", - "name": "availableprocessors", - "type": "integer" + "description": "keypair details", + "name": "keypair", + "type": "string" }, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" + }, + { + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" } - ], - "since": "4.17.0" + ] }, { - "description": "Removes a virtual machine or a list of virtual machines from a load balancer rule.", + "description": "Stops a NetScalervm.", "isasync": true, - "name": "removeFromLoadBalancerRule", + "name": "stopNetScalerVpx", "params": [ { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", + "description": "the ID of the NetScaler vm", "length": 255, - "name": "vmidipmap", - "required": false, - "since": "4.4", - "type": "map" + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "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)", + "description": "Force stop the VM. The caller knows the VM is stopped.", "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "forced", "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" + "type": "boolean" } ], + "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Lists vm groups", - "isasync": false, - "name": "listInstanceGroups", - "params": [ - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "list instance groups by ID", - "length": 255, - "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", - "required": false, - "type": "uuid" + "description": "the name of the router", + "name": "name", + "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the 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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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 ID of the corresponding network", + "name": "networkid", + "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" + } + ], + "type": "set" + }, + { + "description": "the account associated with the router", "name": "account", - "required": false, "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "the host ID for the router", + "name": "hostid", + "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 version of the code / software in the router", + "name": "softwareversion", + "type": "string" }, { - "description": "list instance groups by name", - "length": 255, - "name": "name", - "required": false, + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - } - ], - "related": "createInstanceGroup,updateInstanceGroup", - "response": [ - {}, + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the project ID of the instance group", + "description": "the project id of the ipaddress", "name": "projectid", "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { @@ -28814,210 +29161,162 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" }, - {}, { - "description": "time and date the instance group was created", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the date and time the router was created", "name": "created", "type": "date" }, { - "description": "the name of the instance group", - "name": "name", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the ID of the instance group", - "name": "id", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" - } - ] - }, - { - "description": "migrates data objects from one secondary storage to destination image store(s)", - "isasync": true, - "name": "migrateSecondaryStorageData", - "params": [ - { - "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated", - "length": 255, - "name": "destpools", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "list" }, { - "description": "id of the image store from where the data is to be migrated", - "length": 255, - "name": "srcpool", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" }, { - "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", - "length": 255, - "name": "migrationtype", - "required": false, + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "Type of migration requested for", - "name": "migrationtype", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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 first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "Response message from migration of secondary storage data objects", - "name": "message", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.15.0" - }, - { - "description": "Creates a static route", - "isasync": true, - "name": "createStaticRoute", - "params": [ + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, { - "description": "static route cidr", - "length": 255, - "name": "cidr", - "required": true, + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the gateway id we are creating static route for", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway", - "required": true, - "type": "uuid" - } - ], - "related": "listStaticRoutes", - "response": [ + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, { - "description": "the project id of the static route", - "name": "projectid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the domain associated with the static route", - "name": "domainid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the domain associated with the static route", - "name": "domain", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, {}, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "static route CIDR", - "name": "cidr", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the list of resource tags associated with static route", - "name": "tags", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" } ], "type": "list" }, { - "description": "the state of the static route", - "name": "state", - "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", @@ -29025,461 +29324,367 @@ "type": "integer" }, { - "description": "the ID of static route", + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the id of the router", "name": "id", "type": "string" }, { - "description": "the project name of the static route", - "name": "project", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the account associated with the static route", - "name": "account", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" } ] }, { - "description": "Destroys a Volume.", - "isasync": true, - "name": "destroyVolume", + "description": "Delete a Ucs manager", + "isasync": false, + "name": "deleteUcsManager", "params": [ { - "description": "The ID of the volume", + "description": "ucs manager id", "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", + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", "required": true, "type": "uuid" - }, - { - "description": "If true is passed, the volume is expunged immediately. False by default.", - "length": 255, - "name": "expunge", - "required": false, - "since": "4.6.0", - "type": "boolean" } ], - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "pod id of the volume", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Deletes a host.", + "isasync": false, + "name": "deleteHost", + "params": [ { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", + "length": 255, + "name": "forcedestroylocalstorage", + "required": false, + "type": "boolean" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, + "description": "the host ID", + "length": 255, + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Deletes a vm group", + "isasync": false, + "name": "deleteInstanceGroup", + "params": [ { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "the ID of the instance group", + "length": 255, + "name": "id", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "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": "deletes the resource icon from the specified resource(s)", + "isasync": false, + "name": "deleteResourceIcon", + "params": [ { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, + "description": "list of resources to upload the icon/image for", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" + } + ], + "response": [ + {}, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the path of the volume", - "name": "path", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ], + "since": "4.16.0.0" + }, + { + "description": "Lists capabilities", + "isasync": false, + "name": "listCapabilities", + "params": [], + "related": "", + "response": [ { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "Max allowed number of api requests within the specified interval", + "name": "apilimitmax", + "type": "integer" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if stats are retained for instance disks otherwise false", + "name": "instancesdisksstatsretentionenabled", "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "true if snapshot is supported for KVM host, false otherwise", + "name": "kvmsnapshotenabled", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "version of the cloud stack", + "name": "cloudstackversion", "type": "string" }, + {}, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "true if Kubernetes Service plugin is enabled, false otherwise", + "name": "kubernetesserviceenabled", + "type": "boolean" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "true if dynamic role-based api checker is enabled, false otherwise", + "name": "dynamicrolesenabled", + "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if region wide secondary is enabled, false otherwise", + "name": "regionsecondaryenabled", + "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", + "name": "kubernetesclusterexperimentalfeaturesenabled", + "type": "boolean" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "default page size in the UI for various views, value set in the configurations", + "name": "defaultuipagesize", "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - {}, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "If invitation confirmation is required when add account to project", + "name": "projectinviterequired", + "type": "boolean" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "true if the user can recover and expunge virtualmachines, false otherwise", + "name": "allowuserexpungerecovervm", + "type": "boolean" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the retention time for Instances disks stats", + "name": "instancesdisksstatsretentiontime", + "type": "integer" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "true if stats are collected only for user instances, false if system instance stats are also collected", + "name": "instancesstatsuseronly", + "type": "boolean" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "true if users can see all accounts within the same domain, false otherwise", + "name": "allowuserviewalldomainaccounts", + "type": "boolean" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if user and domain admins can set templates to be shared, false otherwise", + "name": "userpublictemplateenabled", "type": "boolean" }, - {}, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "true if regular user is allowed to create projects", + "name": "allowusercreateprojects", + "type": "boolean" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the retention time for Instances stats", + "name": "instancesstatsretentiontime", + "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "time interval (in seconds) to reset api count", + "name": "apilimitinterval", + "type": "integer" }, { - "description": "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": "maximum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingmaxsize", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", + "name": "allowuserviewdestroyedvm", "type": "boolean" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the 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", + "description": "true if region supports elastic load balancer on basic zones", + "name": "supportELB", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "minimum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingminsize", "type": "long" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true if the user can recover and expunge volumes, false otherwise", + "name": "allowuserexpungerecovervolume", "type": "boolean" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" } - ], - "since": "4.14.0" + ] }, { - "description": "Adds traffic type to a physical network", + "description": "Updates traffic type of a physical network", "isasync": true, - "name": "addTrafficType", + "name": "updateTrafficType", "params": [ { - "description": "the trafficType to be added to the physical network", + "description": "traffic type id", "length": 255, - "name": "traffictype", + "name": "id", + "related": "addTrafficType,updateTrafficType", "required": true, - "type": "string" - }, - { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "length": 255, - "name": "kvmnetworklabel", - "required": false, - "type": "string" + "type": "uuid" }, { "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", @@ -29488,13 +29693,6 @@ "required": false, "type": "string" }, - { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", - "length": 255, - "name": "hypervnetworklabel", - "required": false, - "type": "string" - }, { "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, @@ -29503,24 +29701,16 @@ "type": "string" }, { - "description": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "isolationmethod", + "name": "hypervnetworklabel", "required": false, "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "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 KVM host", "length": 255, - "name": "vlan", + "name": "kvmnetworklabel", "required": false, "type": "string" }, @@ -29532,37 +29722,26 @@ "type": "string" } ], - "related": "", + "related": "addTrafficType", "response": [ { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", - "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": "The network name label of the physical device dedicated to this traffic on a HyperV host", "name": "hypervnetworklabel", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "The 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", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, { @@ -29570,35 +29749,46 @@ "name": "traffictype", "type": "string" }, + {}, + { + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", + "type": "string" + }, { "description": "id of the network provider", "name": "id", "type": "string" }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "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": "Deletes a Private gateway", + "description": "Release dedication of zone", "isasync": true, - "name": "deletePrivateGateway", + "name": "releaseDedicatedZone", "params": [ { - "description": "the ID of the private gateway", + "description": "the ID of the Zone", "length": 255, - "name": "id", - "related": "createPrivateGateway,createPrivateGateway", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" } @@ -29609,10 +29799,11 @@ "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", @@ -29620,27 +29811,48 @@ "type": "boolean" }, {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, { - "description": "List all virtual machine instances that are assigned to a load balancer rule.", + "description": "List Conditions for VM auto scaling", "isasync": false, - "name": "listLoadBalancerRuleInstances", + "name": "listConditions", "params": [ { - "description": "the ID of the load balancer rule", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, "type": "uuid" }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, { "description": "", "length": 255, @@ -29655,6 +29867,14 @@ "required": false, "type": "string" }, + { + "description": "Counter-id of the condition.", + "length": 255, + "name": "counterid", + "related": "createCounter,listCounters", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -29663,35 +29883,39 @@ "type": "integer" }, { - "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", + "description": "the ID of the policy", "length": 255, - "name": "applied", + "name": "policyid", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if load balancer rule VM IP information to be included; default is false", + "description": "ID of the Condition.", "length": 255, - "name": "lbvmips", + "name": "id", + "related": "createCondition,listConditions", + "required": false, + "type": "uuid" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", "required": false, "type": "boolean" } ], - "related": "listLoadBalancerRuleInstances", + "related": "createCondition", "response": [ { - "description": "IP addresses of the vm set of lb rule", - "name": "lbvmipaddresses", - "type": "list" - }, - { - "description": "the user vm set for lb rule", - "name": "loadbalancerruleinstance", - "type": "uservmresponse" + "description": "the domain name of the owner.", + "name": "domain", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { @@ -29699,437 +29923,558 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the Id of the Counter.", + "name": "counterid", + "type": "string" + }, + {}, {}, - {} - ] - }, - { - "description": "Removes a condition", - "isasync": true, - "name": "deleteCondition", - "params": [ { - "description": "the ID of the condition.", - "length": 255, + "description": "zone id of counter", + "name": "zoneid", + "type": "string" + }, + { + "description": "the id of the Condition", "name": "id", - "related": "createCondition", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "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 domain id of the Condition owner", + "name": "domainid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" + }, + { + "description": "the project name of the Condition", + "name": "project", "type": "string" }, - {} + { + "description": "the owner of the Condition.", + "name": "account", + "type": "string" + }, + { + "description": "the Name of the Counter.", + "name": "countername", + "type": "string" + }, + { + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" + } ] }, { - "description": "Updates a domain with a new name", - "isasync": false, - "name": "updateDomain", + "description": "Updates a network serviceProvider of a physical network", + "isasync": true, + "name": "updateNetworkServiceProvider", "params": [ { - "description": "ID of domain to update", + "description": "network service provider id", "length": 255, "name": "id", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", "required": true, "type": "uuid" }, { - "description": "updates domain with this name", + "description": "the list of services to be enabled for this physical network service provider", "length": 255, - "name": "name", + "name": "servicelist", "required": false, - "type": "string" + "type": "list" }, { - "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", + "description": "Enabled/Disabled/Shutdown the physical network service provider", "length": 255, - "name": "networkdomain", + "name": "state", "required": false, "type": "string" } ], - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "response": [ { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, - { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, + {}, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses this domain 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 level of the domain", - "name": "level", - "type": "integer" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists Management Server metrics", + "isasync": false, + "name": "listManagementServersMetrics", + "params": [ + { + "description": "include system level stats", + "length": 255, + "name": "system", + "related": "listManagementServersMetrics", + "required": false, + "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the name of the management server", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "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 management server", + "length": 255, + "name": "id", + "related": "listManagementServers", + "required": false, + "type": "uuid" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "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 number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the ID of the management server", + "name": "id", + "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "Total system memory", + "name": "systemmemorytotal", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the system load for user, and system processes and the system idle cycles", + "name": "systemcycleusage", + "type": "long[]" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the version of the management server", + "name": "version", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" + "description": "the amount of memory allocated to this Management Server", + "name": "heapmemorytotal", + "type": "long" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "The number of daemon threads", + "name": "threadsdaemoncount", + "type": "integer" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", - "type": "string" + "description": "the system is running against a local database", + "name": "dbislocal", + "type": "boolean" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" + "description": "the total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", - "type": "string" + "description": "The number of blocked threads", + "name": "threadsblockedcount", + "type": "integer" }, { - "description": "the path of the domain", - "name": "path", - "type": "string" + "description": "The number of terminated threads", + "name": "threadsteminatedcount", + "type": "integer" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", - "type": "string" + "description": "The number of waiting threads", + "name": "threadswaitingcount", + "type": "integer" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "Free system memory", + "name": "systemmemoryfree", "type": "string" }, - {}, - { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" - }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the amount of memory used by this Management Server", + "name": "heapmemoryused", "type": "long" }, + {}, { - "description": "the name of the domain", - "name": "name", + "description": "the current cpu load", + "name": "cpuload", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "Virtual size of the fully loaded process", + "name": "systemmemoryvirtualsize", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "The number of runnable threads", + "name": "threadsrunnablecount", + "type": "integer" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the log files and their usage on disk", + "name": "loginfo", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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" + "description": "the load averages for 1 5 and 15 minutes", + "name": "systemloadaverages", + "type": "double[]" }, + {}, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" + "description": "the number of agents this Management Server is responsible for", + "name": "agentcount", + "type": "integer" }, { - "description": "the state of the domain", - "name": "state", + "description": "the name of the management server", + "name": "name", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "Amount of memory used", + "name": "systemmemoryused", + "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The number of threads", + "name": "threadstotalcount", + "type": "integer" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the version of the java distribution running the management server process", + "name": "javaversion", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "the number of client sessions active on this Management Server", + "name": "sessions", "type": "long" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" + "description": "the number of processors available to the JVM", + "name": "availableprocessors", + "type": "integer" + }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "the system has a usage server running locally", + "name": "usageislocal", + "type": "boolean" } - ] + ], + "since": "4.17.0" }, { - "description": "Updates a physical network", + "description": "Removes a virtual machine or a list of virtual machines from a load balancer rule.", "isasync": true, - "name": "updatePhysicalNetwork", + "name": "removeFromLoadBalancerRule", "params": [ { - "description": "Tag the physical network", + "description": "the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)", "length": 255, - "name": "tags", + "name": "virtualmachineids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, "type": "list" }, { - "description": "the VLAN for the physical network", + "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", "length": 255, - "name": "vlan", + "name": "vmidipmap", "required": false, + "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" + } + ], + "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 speed for the physical network[1G/10G]", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists vm groups", + "isasync": false, + "name": "listInstanceGroups", + "params": [ + { + "description": "list instance groups by name", "length": 255, - "name": "networkspeed", + "name": "name", "required": false, "type": "string" }, { - "description": "Enabled/Disabled", + "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": "boolean" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "physical network id", + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list instance groups by ID", "length": 255, "name": "id", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "required": false, "type": "uuid" - } - ], - "related": "createPhysicalNetwork", - "response": [ - {}, + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", - "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 speed of the physical network", - "name": "networkspeed", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, - {}, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "createInstanceGroup,updateInstanceGroup", + "response": [ + { + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "comma separated tag", - "name": "tags", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "name of the physical network", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, { - "description": "state of the physical network", - "name": "state", - "type": "string" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "the ID of the instance group", + "name": "id", "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, { @@ -30138,32 +30483,51 @@ "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "the account owning the instance group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the instance group", + "name": "project", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Disables an AutoScale Vm Group", + "description": "migrates data objects from one secondary storage to destination image store(s)", "isasync": true, - "name": "disableAutoScaleVmGroup", + "name": "migrateSecondaryStorageData", "params": [ { - "description": "the ID of the autoscale group", + "description": "id of the image store from where the data is to be migrated", "length": 255, - "name": "id", - "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "name": "srcpool", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": true, "type": "uuid" + }, + { + "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated", + "length": 255, + "name": "destpools", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": true, + "type": "list" + }, + { + "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", + "length": 255, + "name": "migrationtype", + "required": false, + "type": "string" } ], - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "related": "", "response": [ { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "Type of migration requested for", + "name": "migrationtype", "type": "string" }, { @@ -30172,1637 +30536,1317 @@ "type": "integer" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "Response message from migration of secondary storage data objects", + "name": "message", + "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, + {}, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the project id vm profile", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {}, + } + ], + "since": "4.15.0" + }, + { + "description": "Creates a static route", + "isasync": true, + "name": "createStaticRoute", + "params": [ { - "description": "the project name of the vm profile", - "name": "project", + "description": "static route cidr", + "length": 255, + "name": "cidr", + "required": true, "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, + "description": "the gateway id we are creating static route for", + "length": 255, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway", + "required": true, + "type": "uuid" + } + ], + "related": "listStaticRoutes", + "response": [ { - "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 static route", + "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 static route", + "name": "domainid", "type": "string" }, + {}, { - "description": "the current state of the AutoScale Vm Group", + "description": "the state of the static route", "name": "state", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the project name of the static route", + "name": "project", "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" - }, - { - "description": "the domain name of the vm profile", + "description": "the domain associated with the static route", "name": "domain", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" - }, - { - "description": "the autoscale vm group ID", + "description": "the ID of static route", "name": "id", "type": "string" }, - {} - ] - }, - { - "description": "Creates a snapshot policy for the account.", - "isasync": false, - "name": "createSnapshotPolicy", - "params": [ - { - "description": "time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)", - "length": 255, - "name": "schedule", - "required": true, - "type": "string" - }, + {}, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": true, + "description": "the account associated with the static route", + "name": "account", "type": "string" }, { - "description": "an optional field, whether to the display the policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "maximum number of snapshots to retain", - "length": 255, - "name": "maxsnaps", - "required": true, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "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", - "required": true, - "type": "uuid" - }, - { - "description": "Map of tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", - "length": 255, - "name": "intervaltype", - "required": true, + "description": "static route CIDR", + "name": "cidr", "type": "string" - } - ], - "related": "updateSnapshotPolicy", - "response": [ + }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with static route", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "VPC gateway the route is created for", + "name": "gatewayid", + "type": "string" + } + ] + }, + { + "description": "Destroys a Volume.", + "isasync": true, + "name": "destroyVolume", + "params": [ + { + "description": "The ID of the volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "If true is passed, the volume is expunged immediately. False by default.", + "length": 255, + "name": "expunge", + "required": false, + "since": "4.6.0", "type": "boolean" + } + ], + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "response": [ + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the ID of the snapshot policy", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - {}, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" - } - ] - }, - { - "description": "Disables HA for a zone", - "isasync": true, - "name": "disableHAForZone", - "params": [ + }, { - "description": "ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, - {} - ], - "since": "4.11" - }, - { - "description": "Adds an API permission to a role", - "isasync": false, - "name": "createRolePermission", - "params": [ { - "description": "The API name or wildcard rule such as list*", - "length": 255, - "name": "rule", - "required": true, + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "ID of the role", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, - "type": "uuid" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "The description of the role permission", - "length": 255, - "name": "description", - "required": false, + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "The rule permission, allow or deny. Default: deny.", - "length": 255, - "name": "permission", - "required": true, - "type": "string" - } - ], - "related": "listRolePermissions", - "response": [ - {}, - { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the ID of the role permission", - "name": "id", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", - "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "List system virtual machines.", - "isasync": false, - "name": "listSystemVms", - "params": [ - { - "description": "the storage ID where vm's volumes belong to", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "3.0.1", - "type": "uuid" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the Zone ID of the system VM", - "length": 255, + "description": "ID of the availability zone", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the system VM", - "length": 255, + "description": "name of the disk volume", "name": "name", - "required": false, "type": "string" }, { - "description": "the ID of the system VM", - "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": false, - "type": "uuid" - }, - { - "description": "the Pod ID of the system VM", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "the state of the system VM", - "length": 255, - "name": "state", - "required": false, + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", - "length": 255, - "name": "systemvmtype", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the host ID of the system VM", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": false, - "type": "uuid" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "name of the virtual machine", + "name": "vmname", "type": "string" - } - ], - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the path of the volume", + "name": "path", "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 write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, - {}, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, + {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the ID of the 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 public netmask for the system VM", - "name": "publicnetmask", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, - {}, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the name of the system VM", - "name": "name", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, + {}, { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "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 state of the system VM", - "name": "state", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the 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 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 key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "pod id of the volume", + "name": "podid", "type": "string" } - ] + ], + "since": "4.14.0" }, { - "description": "Creates a project", + "description": "Adds traffic type to a physical network", "isasync": true, - "name": "createProject", + "name": "addTrafficType", "params": [ { - "description": "account who will be Admin for the project", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, - "name": "account", + "name": "vmwarenetworklabel", "required": false, "type": "string" }, { - "description": "name of the project", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "length": 255, - "name": "name", - "required": true, + "name": "xennetworklabel", + "required": false, "type": "string" }, { - "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", + "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": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "isolationmethod", "required": false, - "since": "4.15.0", - "type": "uuid" + "type": "string" }, { - "description": "display text of the project", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "length": 255, - "name": "displaytext", + "name": "kvmnetworklabel", + "required": false, + "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,updatePhysicalNetwork", "required": true, + "type": "uuid" + }, + { + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "length": 255, + "name": "ovm3networklabel", + "required": false, "type": "string" }, { - "description": "ID of the account owning a project", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "hypervnetworklabel", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "domain ID of the account owning a project", + "description": "the trafficType to be added to the physical network", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "traffictype", + "required": true, + "type": "string" + }, + { + "description": "The VLAN id to be used for Management traffic by VMware host", + "length": 255, + "name": "vlan", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "related": "", "response": [ { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the trafficType to be added to the physical network", + "name": "traffictype", "type": "string" }, + {}, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", + "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "id of the network provider", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", "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 total number of templates which can be created by this project", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Deletes a Private gateway", + "isasync": true, + "name": "deletePrivateGateway", + "params": [ { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, + "description": "the ID of the private gateway", + "length": 255, + "name": "id", + "related": "createPrivateGateway,createPrivateGateway", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "List all virtual machine instances that are assigned to a load balancer rule.", + "isasync": false, + "name": "listLoadBalancerRuleInstances", + "params": [ { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "true if load balancer rule VM IP information to be included; default is false", + "length": 255, + "name": "lbvmips", + "required": false, + "type": "boolean" }, { - "description": "the id of the project", - "name": "id", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" + "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 total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, + "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", + "length": 255, + "name": "applied", + "required": false, + "type": "boolean" + } + ], + "related": "listLoadBalancerRuleInstances", + "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" + "description": "the user vm set for lb rule", + "name": "loadbalancerruleinstance", + "type": "uservmresponse" }, {}, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" + "description": "IP addresses of the vm set of lb rule", + "name": "lbvmipaddresses", + "type": "list" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the name of the project", - "name": "name", - "type": "string" - }, - { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "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 networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" - }, - { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" - }, - { - "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" } - ], - "since": "3.0.0" + ] }, { - "description": "Assigns a certificate to a load balancer rule", + "description": "Removes a condition for VM auto scaling", "isasync": true, - "name": "assignCertToLoadBalancer", + "name": "deleteCondition", "params": [ { - "description": "the ID of the certificate", - "length": 255, - "name": "certid", - "related": "uploadSslCert", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of the load balancer rule", + "description": "the ID of the condition.", "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "id", + "related": "createCondition", "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 UUID of the latest async job acting on 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": "Adds a Cisco Vnmc Controller", + "description": "Updates a domain with a new name", "isasync": false, - "name": "addCiscoVnmcResource", + "name": "updateDomain", "params": [ { - "description": "Credentials to access the Cisco VNMC Controller API", + "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", "length": 255, - "name": "password", - "required": true, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "Credentials to access the Cisco VNMC Controller API", + "description": "updates domain with this name", "length": 255, - "name": "username", - "required": true, + "name": "name", + "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "ID of domain to update", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "id", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": true, "type": "uuid" - }, - { - "description": "Hostname or ip address of the Cisco VNMC Controller.", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" } ], - "related": "listCiscoVnmcResources", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "response": [ - {}, - {}, - {}, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Detaches a disk volume from a virtual machine.", - "isasync": true, - "name": "detachVolume", - "params": [ { - "description": "the device ID on the virtual machine where volume is detached from", - "length": 255, - "name": "deviceid", - "required": false, - "type": "long" + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "type": "uuid" + "description": "the path of the domain", + "name": "path", + "type": "string" }, { - "description": "the ID of the virtual machine where the volume is detached from", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "type": "uuid" - } - ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" + }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the name of the domain", + "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": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, + {}, + {}, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "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": "name of the disk offering", - "name": "diskofferingname", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, - {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the date the disk volume was created", + "description": "the date when this domain was created", "name": "created", "type": "date" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" + } + ] + }, + { + "description": "Updates a physical network", + "isasync": true, + "name": "updatePhysicalNetwork", + "params": [ + { + "description": "Enabled/Disabled", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the VLAN for the physical network", + "length": 255, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "Tag the physical network", + "length": 255, + "name": "tags", + "required": false, + "type": "list" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "physical network id", + "length": 255, + "name": "id", + "related": "createPhysicalNetwork,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the speed for the physical network[1G/10G]", + "length": 255, + "name": "networkspeed", + "required": false, "type": "string" - }, + } + ], + "related": "createPhysicalNetwork", + "response": [ { - "description": "the state of the disk volume", - "name": "state", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "name of the physical network", + "name": "name", + "type": "string" }, + {}, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "comma separated tag", + "name": "tags", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", + "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 domain associated with the disk volume", - "name": "domain", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, - {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "state of the physical network", + "name": "state", "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Replaces ACL associated with a network or private gateway", + "description": "Disables an AutoScale Vm Group", "isasync": true, - "name": "replaceNetworkACLList", + "name": "disableAutoScaleVmGroup", "params": [ { - "description": "the ID of the network ACL", + "description": "the ID of the autoscale group", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "id", + "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "required": true, "type": "uuid" - }, - { - "description": "the ID of the network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the private gateway", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway", - "required": false, - "type": "uuid" } ], + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} - ] - }, - { - "description": "Marks a default zone for this account", - "isasync": true, - "name": "markDefaultZoneForAccount", - "params": [ - { - "description": "Marks the account that belongs to the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", + "type": "string" }, { - "description": "Name of the account that is to be marked.", - "length": 255, - "name": "account", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": true, + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "The Zone ID with which the account is to be marked.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "response": [ - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", + "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { @@ -31811,462 +31855,544 @@ "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, + {}, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "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 id of the account", - "name": "id", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the current state of the AutoScale Vm Group", + "name": "state", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the public ip address", + "name": "publicip", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the domain name of the vm group", + "name": "domain", + "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the vm group", + "name": "project", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the project id of the vm group", + "name": "projectid", + "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the account owning the vm group", + "name": "account", "type": "string" + } + ] + }, + { + "description": "Creates a snapshot policy for the account.", + "isasync": false, + "name": "createSnapshotPolicy", + "params": [ + { + "description": "maximum number of snapshots to retain", + "length": 255, + "name": "maxsnaps", + "required": true, + "type": "integer" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "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": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "length": 255, + "name": "timezone", + "required": true, "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "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": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "length": 255, + "name": "intervaltype", + "required": true, "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)", + "length": 255, + "name": "schedule", + "required": true, + "type": "string" + } + ], + "related": "updateSnapshotPolicy", + "response": [ + { + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, + { + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, + {}, { - "description": "the list of users associated with account", - "name": "user", + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain ID of the user", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account name of the user", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the domain name of the user", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, + {}, + { + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" + } + ] + }, + { + "description": "create Tungsten-Fabric management network", + "isasync": false, + "name": "createTungstenFabricManagementNetwork", + "params": [ + { + "description": "the ID of pod", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "any text associated with the success or failure", + "name": "displaytext", "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 virtual machines stopped for this account", - "name": "vmstopped", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {} + ] + }, + { + "description": "Disables HA for a zone", + "isasync": true, + "name": "disableHAForZone", + "params": [ { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the 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" - }, + } + ], + "since": "4.11" + }, + { + "description": "list Tungsten-Fabric firewall rule", + "isasync": false, + "name": "listTungstenFabricFirewallRule", + "params": [ { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the uuid of Tungsten-Fabric firewall rule", + "length": 255, + "name": "firewallruleuuid", + "required": false, "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the state of the account", - "name": "state", + "description": "the uuid of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "required": false, "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "Tungsten-Fabric firewall rule name", + "name": "name", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", + "type": "string" }, - {}, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" }, + {}, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Tungsten-Fabric firewall rule action", + "name": "action", + "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", + "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", "type": "string" } - ], - "since": "4.0" + ] }, { - "description": "Enables out-of-band management for a zone", - "isasync": true, - "name": "enableOutOfBandManagementForZone", + "description": "Adds an API permission to a role", + "isasync": false, + "name": "createRolePermission", "params": [ { - "description": "the ID of the zone", + "description": "The description of the role permission", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,issueOutOfBandManagementPowerAction", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "name": "description", + "required": false, "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - {}, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "the out-of-band management interface address", - "name": "address", + "description": "The rule permission, allow or deny. Default: deny.", + "length": 255, + "name": "permission", + "required": true, "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "The API name or wildcard rule such as list*", + "length": 255, + "name": "rule", + "required": true, "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "ID of the role", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": true, + "type": "uuid" + } + ], + "related": "listRolePermissions", + "response": [ + {}, + { + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", "type": "string" }, { @@ -32275,269 +32401,174 @@ "type": "integer" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the ID of the role permission", + "name": "id", "type": "string" }, - {}, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the api name or wildcard rule", + "name": "rule", + "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, + {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], "since": "4.9.0" }, { - "description": "Lists LDAP Users according to the specifications from the user request.", + "description": "List system virtual machines.", "isasync": false, - "name": "listLdapUsers", + "name": "listSystemVms", "params": [ { - "description": "Determines what type of filter is applied on the list of users returned from LDAP.\n\tvalid values are\n\t'NoFilter'\t no filtering is done,\n\t'LocalDomain'\tusers already in the current or requested domain will be filtered out of the result list,\n\t'AnyDomain'\tusers that already exist anywhere in cloudstack will be filtered out, and\n\t'PotentialImport'\tall users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource", + "description": "the name of the system VM", "length": 255, - "name": "userfilter", + "name": "name", "required": false, - "since": "4.13", "type": "string" }, { - "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": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "linked domain", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, + "since": "3.0.1", "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", + "description": "the state of the system VM", "length": 255, - "name": "listtype", + "name": "state", "required": false, "type": "string" - } - ], - "related": "", - "response": [ - { - "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 authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", - "type": "string" - }, - { - "description": "The user's firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "The user's principle", - "name": "principal", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "The user's domain", - "name": "domain", - "type": "string" - }, - { - "description": "The user's username", - "name": "username", - "type": "string" }, { - "description": "The user's lastname", - "name": "lastname", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Revokes certificate using configured CA plugin", - "isasync": true, - "name": "revokeCertificate", - "params": [ - { - "description": "The certificate CN", + "description": "the Pod ID of the system VM", "length": 255, - "name": "cn", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "description": "", "length": 255, - "name": "provider", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The certificate serial number, as a hex value", + "description": "", "length": 255, - "name": "serial", - "required": true, - "type": "string" - } - ], - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "name": "page", + "required": false, "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} - ], - "since": "4.11.0" - }, - { - "description": "Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a \"Stopped\" state for this command to take effect.", - "isasync": false, - "name": "changeServiceForSystemVm", - "params": [ - { - "description": "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value", + "description": "the host ID of the system VM", "length": 255, - "name": "details", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the service offering ID to apply to the system vm", + "description": "the Zone ID of the system VM", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, "type": "uuid" }, { - "description": "The ID of the system vm", + "description": "the ID of the system VM", "length": 255, "name": "id", - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": true, + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": false, "type": "uuid" } ], - "related": "migrateSystemVm,startSystemVm", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, - { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" - }, { "description": "the network domain for the system VM", "name": "networkdomain", "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 Zone name for the system VM", - "name": "zonename", + "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": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, + {}, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { @@ -32546,23 +32577,28 @@ "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the name of the system VM", + "name": "name", + "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -32571,14 +32607,14 @@ "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { "description": "the Zone ID for the system VM", @@ -32586,44 +32622,38 @@ "type": "string" }, { - "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", + "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 date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, - {}, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { @@ -32631,24 +32661,14 @@ "name": "publicnetmask", "type": "string" }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, { "description": "the host ID for the system VM", "name": "hostid", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" - }, - { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -32657,430 +32677,430 @@ "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, + {}, { "description": "the 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", + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" + }, + { + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" } ] }, { - "description": "Update SIOC info", - "isasync": false, - "name": "updateSiocInfo", + "description": "Creates a project", + "isasync": true, + "name": "createProject", "params": [ { - "description": "Storage Pool ID", + "description": "domain ID of the account owning a project", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, "type": "uuid" }, { - "description": "Limit IOPS per GB", + "description": "name of the project", "length": 255, - "name": "limitiopspergb", + "name": "name", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Zone ID", + "description": "ID of the account owning a project", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, "type": "uuid" }, { - "description": "Notify if IOPS above this value", + "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", "length": 255, - "name": "iopsnotifythreshold", - "required": true, - "type": "integer" + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "since": "4.15.0", + "type": "uuid" }, { - "description": "Shares per GB", + "description": "account who will be Admin for the project", "length": 255, - "name": "sharespergb", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "display text of the project", + "length": 255, + "name": "displaytext", "required": true, - "type": "integer" + "type": "string" } ], - "related": "", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "response": [ { - "description": "The return message from the operation ('Success' if successful)", - "name": "msg", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" }, - {}, - {} - ], - "since": "4.11.0" - }, - { - "description": "List the IP forwarding rules", - "isasync": false, - "name": "listIpForwardingRules", - "params": [ { - "description": "Lists all rules applied to the specified VM.", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "type": "uuid" + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "list the rule belonging to this public IP address", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" }, { - "description": "Lists rule with the specified ID.", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": false, - "type": "uuid" + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the state of the project", + "name": "state", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - } - ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule", - "response": [ + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" + }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the 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 ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", "type": "integer" }, - {}, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, - {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "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 project", + "name": "memoryavailable", "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + {}, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + {}, + { + "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" - } - ] - }, - { - "description": "Creates an instant snapshot of a volume.", - "isasync": true, - "name": "createSnapshot", - "params": [ + }, { - "description": "asynchronous backup if true", - "length": 255, - "name": "asyncbackup", - "required": false, - "type": "boolean" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", - "length": 255, - "name": "policyid", - "related": "updateSnapshotPolicy", - "required": false, - "type": "uuid" + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" }, { - "description": "the name of the snapshot", - "length": 255, + "description": "the name of the project", "name": "name", - "required": false, "type": "string" }, { - "description": "Map of tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "The ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "quiesce vm if true", - "length": 255, - "name": "quiescevm", - "required": false, - "type": "boolean" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", - "length": 255, - "name": "locationtype", - "required": false, + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Assigns a certificate to a load balancer rule", + "isasync": true, + "name": "assignCertToLoadBalancer", + "params": [ + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" }, { - "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", + "description": "the ID of the certificate", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "certid", + "related": "uploadSslCert", + "required": true, + "type": "uuid" } ], - "related": "createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot", "response": [ { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" - }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -33089,123 +33109,188 @@ "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Adds a Cisco Vnmc Controller", + "isasync": false, + "name": "addCiscoVnmcResource", + "params": [ + { + "description": "Hostname or ip address of the Cisco VNMC Controller.", + "length": 255, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "Credentials to access the Cisco VNMC Controller API", + "length": 255, + "name": "password", + "required": true, + "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "Credentials to access the Cisco VNMC Controller API", + "length": 255, + "name": "username", + "required": true, "type": "string" }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + } + ], + "related": "listCiscoVnmcResources", + "response": [ + {}, + {}, + {}, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "name of the snapshot", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Detaches a disk volume from a virtual machine.", + "isasync": true, + "name": "detachVolume", + "params": [ { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" + "description": "the device ID on the virtual machine where volume is detached from", + "length": 255, + "name": "deviceid", + "required": false, + "type": "long" }, { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": false, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the ID of the virtual machine where the volume is detached from", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": false, + "type": "uuid" + } + ], + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "response": [ + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "state of the virtual machine", + "name": "vmstate", "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 display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the 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" }, { @@ -33214,379 +33299,357 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the 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": "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" } ], "type": "set" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, - {} - ] - }, - { - "description": "Deletes a vmsnapshot.", - "isasync": true, - "name": "deleteVMSnapshot", - "params": [ - { - "description": "The ID of the VM snapshot", - "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": true, - "type": "uuid" - } - ], - "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, - {}, - {} - ], - "since": "4.2.0" - }, - { - "description": "Lists storage pool metrics", - "isasync": false, - "name": "listStoragePoolsMetrics", - "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "the name of the storage pool", - "length": 255, - "name": "name", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the Pod ID for the storage pool", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the storage pool path", - "length": 255, - "name": "path", - "required": false, - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the ID of the storage pool", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the Zone ID for the storage pool", - "length": 255, + "description": "ID of the availability zone", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the IP address for the storage pool", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the ID of the storage pool", - "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "list storage pools belongig to the specific cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "storage usage notification threshold exceeded", - "name": "storageusagethreshold", - "type": "boolean" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the storage pool path", - "name": "path", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the Pod name of the storage pool", + "description": "pod name of the volume", "name": "podname", "type": "string" }, { - "description": "storage usage disable threshold exceeded", - "name": "storageusagedisablethreshold", - "type": "boolean" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "disk size in GiB", - "name": "disksizetotalgb", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "disk size allocated in GiB", - "name": "disksizeallocatedgb", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, + {}, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, - {}, { - "description": "the name of the storage pool", - "name": "name", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "storage allocated disable threshold exceeded", - "name": "storageallocateddisablethreshold", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the storage pool type", - "name": "type", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "storage allocated notification threshold exceeded", - "name": "storageallocatedthreshold", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "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 project id of the vpn", + "name": "projectid", + "type": "string" }, - {}, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "disk size used in GiB", - "name": "disksizeusedgb", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, + {}, { - "description": "disk size unallocated in GiB", - "name": "disksizeunallocatedgb", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "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": "the bytes allocated", + "name": "physicalsize", + "type": "long" } - ], - "since": "4.9.3" + ] }, { - "description": "Unmanage a guest virtual machine.", + "description": "Replaces ACL associated with a network or private gateway", "isasync": true, - "name": "unmanageVirtualMachine", + "name": "replaceNetworkACLList", "params": [ { - "description": "The ID of the virtual machine to unmanage", + "description": "the ID of the private gateway", "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the network ACL", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": true, "type": "uuid" } ], - "related": "", "response": [ { - "description": "details of the unmanage VM operation", - "name": "details", + "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": "result of the unmanage VM operation", + "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, @@ -33594,85 +33657,77 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {} - ], - "since": "4.15.0" + } + ] }, { - "description": "Starts a router.", - "isasync": true, - "name": "rebootRouter", + "description": "list Tungsten-Fabric address group", + "isasync": false, + "name": "listTungstenFabricAddressGroup", "params": [ { - "description": "the ID of the router", + "description": "the ID of zone", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "required": true, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, "type": "uuid" }, { - "description": "Force reboot the router (Router is force Stopped and then Started)", + "description": "the uuid of Tungsten-Fabric address group", "length": 255, - "name": "forced", + "name": "addressgroupuuid", "required": false, - "since": "4.16.0", - "type": "boolean" - } - ], - "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "response": [ - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, - {}, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "createTungstenFabricAddressGroup", + "response": [ { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "Tungsten-Fabric address group name", + "name": "name", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", "type": "string" }, { @@ -33680,771 +33735,870 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + } + ] + }, + { + "description": "Marks a default zone for this account", + "isasync": true, + "name": "markDefaultZoneForAccount", + "params": [ + { + "description": "Marks the account that belongs to the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": true, + "type": "uuid" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "Name of the account that is to be marked.", + "length": 255, + "name": "account", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": true, "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "The Zone ID with which the account is to be marked.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "response": [ + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + {}, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", "type": "boolean" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the ID of the nic", + "description": "the user ID", "name": "id", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the type of the nic", - "name": "type", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the account name of the user", + "name": "account", "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": "the user state", + "name": "state", "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" } ], - "type": "set" + "type": "list" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the date and time the router was created", + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the date when this account was created", "name": "created", "type": "date" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "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 total volume which can be used by this account", + "name": "volumelimit", + "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the id of the router", - "name": "id", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "role of the domain router", - "name": "role", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, + {}, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the default zone of the account", + "name": "defaultzoneid", "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": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the project name of the address", - "name": "project", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" - } - ] - }, - { - "description": "list the vm nics IP to NIC", - "isasync": false, - "name": "listNics", - "params": [ + }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, { - "description": "the ID of the nic to to list IPs", - "length": 255, - "name": "nicid", - "related": "listNics", - "required": false, - "type": "uuid" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "list nic of the specific vm's network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "the ID of the vm", + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" + } + ], + "since": "4.0" + }, + { + "description": "Enables out-of-band management for a zone", + "isasync": true, + "name": "enableOutOfBandManagementForZone", + "params": [ + { + "description": "the ID of the zone", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" } ], - "related": "", + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,issueOutOfBandManagementPowerAction", "response": [ + {}, + {}, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the 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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "Lists LDAP Users according to the specifications from the user request.", + "isasync": false, + "name": "listLdapUsers", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "linked domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", + "length": 255, + "name": "listtype", + "required": false, + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Determines what type of filter is applied on the list of users returned from LDAP.\n\tvalid values are\n\t'NoFilter'\t no filtering is done,\n\t'LocalDomain'\tusers already in the current or requested domain will be filtered out of the result list,\n\t'AnyDomain'\tusers that already exist anywhere in cloudstack will be filtered out, and\n\t'PotentialImport'\tall users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource", + "length": 255, + "name": "userfilter", + "required": false, + "since": "4.13", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "The user's email", + "name": "email", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, - {}, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The user's domain", + "name": "domain", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, + {}, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "The user's username", + "name": "username", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "The user's principle", + "name": "principal", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.2.0" + }, + { + "description": "Revokes certificate using configured CA plugin", + "isasync": true, + "name": "revokeCertificate", + "params": [ + { + "description": "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 type of the nic", - "name": "type", + "description": "The certificate CN", + "length": 255, + "name": "cn", + "required": false, "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "The certificate serial number, as a hex value", + "length": 255, + "name": "serial", + "required": true, "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the ID of the nic", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - } - ] + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} + ], + "since": "4.11.0" }, { - "description": "Create a new keypair and returns the private key", + "description": "Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a \"Stopped\" state for this command to take effect.", "isasync": false, - "name": "createSSHKeyPair", + "name": "changeServiceForSystemVm", "params": [ { - "description": "Name of the keypair", + "description": "the service offering ID to apply to the system vm", "length": 255, - "name": "name", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": true, - "type": "string" - }, - { - "description": "an optional project for the ssh key", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, "type": "uuid" }, { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "The ID of the system vm", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "id", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "migrateSystemVm,startSystemVm", "response": [ - {}, { - "description": "Private key", - "name": "privatekey", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" }, { - "description": "Name of the keypair", + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the system VM", "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the system VM", + "name": "id", + "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 owner of the keypair", - "name": "account", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, {}, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" - } - ] - }, - { - "description": "Creates an instant snapshot of a volume from existing vm snapshot.", - "isasync": true, - "name": "createSnapshotFromVMSnapshot", - "params": [ + }, { - "description": "The ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "The ID of the VM snapshot", - "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": true, - "type": "uuid" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the name of the snapshot", - "length": 255, - "name": "name", - "required": false, + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" - } - ], - "related": "archiveSnapshot,revertSnapshot", - "response": [ + }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "id of the availability zone", - "name": "zoneid", + "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 domain name of the snapshot's account", - "name": "domain", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "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 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": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -34452,204 +34606,189 @@ "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "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", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, + {}, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" } - ], - "since": "4.10.0" + ] }, { - "description": "Authorizes a particular egress rule for this security group", - "isasync": true, - "name": "authorizeSecurityGroupEgress", + "description": "Update SIOC info", + "isasync": false, + "name": "updateSiocInfo", "params": [ { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "Zone ID", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" }, { - "description": "TCP is default. UDP is the other supported protocol", - "length": 255, - "name": "protocol", - "required": false, - "type": "string" - }, - { - "description": "type of the icmp message being sent", + "description": "Shares per GB", "length": 255, - "name": "icmptype", - "required": false, + "name": "sharespergb", + "required": true, "type": "integer" }, { - "description": "an optional project of the security group", + "description": "Storage Pool ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": true, "type": "uuid" }, { - "description": "end port for this egress rule", + "description": "Notify if IOPS above this value", "length": 255, - "name": "endport", - "required": false, + "name": "iopsnotifythreshold", + "required": true, "type": "integer" }, { - "description": "user to security group mapping", - "length": 255, - "name": "usersecuritygrouplist", - "required": false, - "type": "map" - }, - { - "description": "start port for this egress rule", + "description": "Limit IOPS per GB", "length": 255, - "name": "startport", - "required": false, + "name": "limitiopspergb", + "required": true, "type": "integer" - }, - { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + } + ], + "related": "", + "response": [ + {}, + {}, + { + "description": "The return message from the operation ('Success' if successful)", + "name": "msg", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.11.0" + }, + { + "description": "List the IP forwarding rules", + "isasync": false, + "name": "listIpForwardingRules", + "params": [ + { + "description": "list the rule belonging to this public IP address", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains", @@ -34657,89 +34796,105 @@ "type": "uuid" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "securitygroupname", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "description": "Lists all rules applied to the specified VM.", "length": 255, - "name": "cidrlist", + "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,importUnmanagedInstance", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "error code for this icmp message", + "description": "", "length": 255, - "name": "icmpcode", + "name": "page", "required": false, "type": "integer" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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 objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "Lists rule with the specified ID.", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": false, + "type": "uuid" } ], - "related": "authorizeSecurityGroupIngress", + "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", "response": [ - {}, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "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 state of the rule", + "name": "state", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -34748,1079 +34903,4092 @@ "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" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, {}, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, + {}, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "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 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 ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists storage pools.", - "isasync": false, - "name": "listStoragePools", + "description": "Creates an instant snapshot of a volume.", + "isasync": true, + "name": "createSnapshot", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the Zone ID for the storage pool", + "description": "asynchronous backup if true", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "asyncbackup", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "Map of tags (key/value pairs)", "length": 255, - "name": "pagesize", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "the Pod ID for the storage pool", + "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "policyid", + "related": "updateSnapshotPolicy", "required": false, "type": "uuid" }, { - "description": "the IP address for the storage pool", + "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", "length": 255, - "name": "ipaddress", + "name": "account", "required": false, "type": "string" }, { - "description": "list storage pools belongig to the specific cluster", + "description": "The ID of the disk volume", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "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" }, { - "description": "the storage pool path", + "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", "length": 255, - "name": "path", + "name": "locationtype", "required": false, "type": "string" }, { - "description": "the ID of the storage pool", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" - }, - { - "description": "the name of the storage pool", + "description": "the name of the snapshot", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "quiesce vm if true", "length": 255, - "name": "page", + "name": "quiescevm", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the ID of the storage pool", + "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "related": "createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot", "response": [ { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the date and time the storage pool was created", + "description": " the date the snapshot was created", "name": "created", "type": "date" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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": "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" + } + ], + "type": "set" }, {}, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "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", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, - {}, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", "type": "long" }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "the storage pool type", - "name": "type", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, + {}, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the tags for the storage pool", - "name": "tags", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" } ] }, { - "description": "Updates a hypervisor capabilities.", - "isasync": false, - "name": "updateHypervisorCapabilities", + "description": "Deletes a vmsnapshot.", + "isasync": true, + "name": "deleteVMSnapshot", "params": [ { - "description": "set true to enable storage motion support for this hypervisor", + "description": "The ID of the VM snapshot", "length": 255, - "name": "storagemotionenabled", - "required": false, - "since": "4.16.0", - "type": "boolean" - }, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the maximum number of the hypervisor hosts per cluster ", + "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" + }, + { + "description": "Lists storage pool metrics", + "isasync": false, + "name": "listStoragePoolsMetrics", + "params": [ + { + "description": "list storage pools belongig to the specific cluster", "length": 255, - "name": "maxhostspercluster", + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the storage pool", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", "required": false, - "since": "4.16.0", "type": "integer" }, { - "description": "set true to enable VM snapshots for this hypervisor", + "description": "the IP address for the storage pool", "length": 255, - "name": "vmsnapshotenabled", + "name": "ipaddress", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "string" }, { - "description": "set true to enable security group for this hypervisor.", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "securitygroupenabled", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the max number of Guest VMs per host for this hypervisor.", + "description": "", "length": 255, - "name": "maxguestslimit", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" }, { - "description": "ID of the hypervisor capability", + "description": "the ID of the storage pool", "length": 255, "name": "id", - "related": "listHypervisorCapabilities,updateHypervisorCapabilities", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "maxdatavolumeslimit", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "since": "4.16.0", - "type": "integer" + "type": "uuid" + }, + { + "description": "the storage pool path", + "length": 255, + "name": "path", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the ID of the storage pool", + "length": 255, + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "string" } ], - "related": "listHypervisorCapabilities", + "related": "", "response": [ { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" + }, + { + "description": "the storage pool path", + "name": "path", "type": "string" }, - {}, {}, { - "description": "the hypervisor type", - "name": "hypervisor", - "type": "hypervisortype" + "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": "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 and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "disk size in GiB", + "name": "disksizetotalgb", "type": "string" }, { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", + "description": "storage usage notification threshold exceeded", + "name": "storageusagethreshold", "type": "boolean" }, { - "description": "true if security group is supported", - "name": "securitygroupenabled", + "description": "storage allocated notification threshold exceeded", + "name": "storageallocatedthreshold", "type": "boolean" }, + {}, { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" + "description": "storage allocated disable threshold exceeded", + "name": "storageallocateddisablethreshold", + "type": "boolean" }, { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the maximum number of guest vms recommended for this hypervisor", - "name": "maxguestslimit", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "the ID of the hypervisor capabilities row", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "storage usage disable threshold exceeded", + "name": "storageusagedisablethreshold", + "type": "boolean" + }, + { + "description": "the ID of the storage pool", "name": "id", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Find hosts suitable for migrating a virtual machine.", - "isasync": false, - "name": "findHostsForMigration", - "params": [ + }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "disk size allocated in GiB", + "name": "disksizeallocatedgb", + "type": "string" }, { - "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "disk size unallocated in GiB", + "name": "disksizeunallocatedgb", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "disk size used in GiB", + "name": "disksizeusedgb", "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": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the Pod name of the host", + "description": "the Pod name of the storage pool", "name": "podname", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the host version", - "name": "version", + "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" + } + ], + "since": "4.9.3" + }, + { + "description": "Unmanage a guest virtual machine.", + "isasync": true, + "name": "unmanageVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine to unmanage", + "length": 255, + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the ID of the host", + "description": "details of the unmanage VM operation", + "name": "details", + "type": "string" + }, + { + "description": "result of the unmanage VM operation", + "name": "success", + "type": "boolean" + } + ], + "since": "4.15.0" + }, + { + "description": "Starts a router.", + "isasync": true, + "name": "rebootRouter", + "params": [ + { + "description": "Force reboot the router (Router is force Stopped and then Started)", + "length": 255, + "name": "forced", + "required": false, + "since": "4.16.0", + "type": "boolean" + }, + { + "description": "the ID of the router", + "length": 255, "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" + } + ], + "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "response": [ + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", - "name": "cpuwithoverprovisioning", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the second DNS for the router", + "name": "dns2", "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 date and time the host was removed", - "name": "removed", + "description": "the date and time the router was created", + "name": "created", "type": "date" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "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 type of the nic", + "name": "type", + "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the 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": "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 ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "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" + } + ], + "type": "set" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + {}, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "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 host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "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 state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "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 second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + } + ] + }, + { + "description": "list the vm nics IP to NIC", + "isasync": false, + "name": "listNics", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list nic of the specific vm's network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the ID of the nic to to list IPs", + "length": 255, + "name": "nicid", + "related": "listNics", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + {}, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the 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": "Create a new keypair and returns the private key", + "isasync": false, + "name": "createSSHKeyPair", + "params": [ + { + "description": "an optional account for the ssh key. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "an optional project for the ssh key", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Name of the keypair", + "name": "name", + "type": "string" + }, + { + "description": "Private key", + "name": "privatekey", + "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" + }, + { + "description": "ID of the ssh keypair", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the keypair owner", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the owner of the keypair", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the keypair owner", + "name": "domain", + "type": "string" + }, + { + "description": "Fingerprint of the public key", + "name": "fingerprint", + "type": "string" + }, + { + "description": "the domain id of the keypair owner", + "name": "domainid", + "type": "string" + } + ] + }, + { + "description": "Creates an instant snapshot of a volume from existing vm snapshot.", + "isasync": true, + "name": "createSnapshotFromVMSnapshot", + "params": [ + { + "description": "The ID of the VM snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": true, + "type": "uuid" + }, + { + "description": "The ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the snapshot", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "archiveSnapshot,revertSnapshot", + "response": [ + { + "description": "display name of the os on volume", + "name": "osdisplayname", + "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": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the snapshot", + "name": "project", + "type": "string" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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": "ID of the snapshot", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" + }, + { + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "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": "name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "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" + } + ], + "since": "4.10.0" + }, + { + "description": "list Tungsten-Fabric service group", + "isasync": false, + "name": "listTungstenFabricServiceGroup", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric service group", + "length": 255, + "name": "servicegroupuuid", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "createTungstenFabricServiceGroup", + "response": [ + { + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" + }, + { + "description": "Tungsten-Fabric service group protocol", + "name": "protocol", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric service group name", + "name": "name", + "type": "string" + }, + { + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", + "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": "Tungsten-Fabric service group end port", + "name": "endport", + "type": "int" + }, + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + } + ] + }, + { + "description": "Authorizes a particular egress rule for this security group", + "isasync": true, + "name": "authorizeSecurityGroupEgress", + "params": [ + { + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "length": 255, + "name": "securitygroupname", + "required": false, + "type": "string" + }, + { + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "an optional account for the security group. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "start port for this egress rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" + }, + { + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "length": 255, + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", + "required": false, + "type": "uuid" + }, + { + "description": "type of the icmp message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" + }, + { + "description": "user to security group mapping", + "length": 255, + "name": "usersecuritygrouplist", + "required": false, + "type": "map" + }, + { + "description": "end port for this egress rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "an optional project of the security group", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "TCP is default. UDP is the other supported protocol", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" + } + ], + "related": "authorizeSecurityGroupIngress", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "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" + }, + {}, + { + "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + {}, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists storage pools.", + "isasync": false, + "name": "listStoragePools", + "params": [ + { + "description": "the Zone ID for the storage pool", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the storage pool", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the storage pool", + "length": 255, + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "string" + }, + { + "description": "the IP address for the storage pool", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "the storage pool path", + "length": 255, + "name": "path", + "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, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the name of the storage pool", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "response": [ + { + "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": "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 IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the storage pool", + "name": "id", + "type": "string" + }, + { + "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 name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the storage pool path", + "name": "path", + "type": "string" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "the storage pool type", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" + }, + {}, + { + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + }, + { + "description": "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": "Updates a hypervisor capabilities.", + "isasync": false, + "name": "updateHypervisorCapabilities", + "params": [ + { + "description": "set true to enable VM snapshots for this hypervisor", + "length": 255, + "name": "vmsnapshotenabled", + "required": false, + "since": "4.16.0", + "type": "boolean" + }, + { + "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", + "length": 255, + "name": "maxdatavolumeslimit", + "required": false, + "since": "4.16.0", + "type": "integer" + }, + { + "description": "set true to enable security group for this hypervisor.", + "length": 255, + "name": "securitygroupenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the maximum number of the hypervisor hosts per cluster ", + "length": 255, + "name": "maxhostspercluster", + "required": false, + "since": "4.16.0", + "type": "integer" + }, + { + "description": "set true to enable storage motion support for this hypervisor", + "length": 255, + "name": "storagemotionenabled", + "required": false, + "since": "4.16.0", + "type": "boolean" + }, + { + "description": "ID of the hypervisor capability", + "length": 255, + "name": "id", + "related": "listHypervisorCapabilities,updateHypervisorCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "the max number of Guest VMs per host for this hypervisor.", + "length": 255, + "name": "maxguestslimit", + "required": false, + "type": "long" + } + ], + "related": "listHypervisorCapabilities", + "response": [ + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if security group is supported", + "name": "securitygroupenabled", + "type": "boolean" + }, + { + "description": "the hypervisor type", + "name": "hypervisor", + "type": "hypervisortype" + }, + { + "description": "true if storage motion is supported", + "name": "storagemotionenabled", + "type": "boolean" + }, + { + "description": "the ID of the hypervisor capabilities row", + "name": "id", + "type": "string" + }, + {}, + { + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" + }, + { + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" + }, + { + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Find hosts suitable for migrating a virtual machine.", + "isasync": false, + "name": "findHostsForMigration", + "params": [ + { + "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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,importUnmanagedInstance", + "required": true, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, + { + "description": "the cpu average load on the host", + "name": "averageload", + "type": "long" + }, + { + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + }, + {}, + { + "description": "true if migrating a vm to this host requires storage motion, false otherwise", + "name": "requiresStorageMotion", + "type": "boolean" + }, + { + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", + "name": "cpuwithoverprovisioning", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ", + "name": "memorywithoverprovisioning", + "type": "string" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the 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 allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "the 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 memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "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": "the host version", + "name": "version", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" + }, + {}, + { + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + }, + { + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "string" + }, + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "long" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + } + ] + }, + { + "description": "Enable a Cisco Nexus VSM device", + "isasync": true, + "name": "enableCiscoNexusVSM", + "params": [ + { + "description": "Id of the Cisco Nexus 1000v VSM device to be enabled", + "length": 255, + "name": "id", + "related": "listCiscoNexusVSMs,enableCiscoNexusVSM,disableCiscoNexusVSM", + "required": true, + "type": "uuid" + } + ], + "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", + "response": [ + { + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", + "type": "string" + }, + { + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", + "type": "string" + }, + { + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", + "type": "string" + }, + {}, + { + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", + "type": "string" + }, + { + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" + }, + { + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", + "type": "string" + }, + {}, + { + "description": "device name", + "name": "vsmdevicename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" + }, + { + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" + }, + { + "description": "device state", + "name": "vsmdevicestate", + "type": "string" + }, + { + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", + "type": "string" + }, + { + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Return true if the specified account is allowed to create offerings with tags.", + "isasync": false, + "name": "isAccountAllowedToCreateOfferingsWithTags", + "params": [ + { + "description": "Account UUID", + "length": 255, + "name": "id", + "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "is domain admin allowed to create offerings with tags", + "name": "isallowed", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Dedicates a guest vlan range to an account", + "isasync": false, + "name": "dedicateGuestVlanRange", + "params": [ + { + "description": "domain ID of the account owning a VLAN", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "guest vlan range to be dedicated", + "length": 255, + "name": "vlanrange", + "required": true, + "type": "string" + }, + { + "description": "physical network ID of the vlan", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "account who will own the VLAN", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "listDedicatedGuestVlanRanges", + "response": [ + { + "description": "the zone of the guest vlan range", + "name": "zoneid", + "type": "long" + }, + { + "description": "the guest VLAN range", + "name": "guestvlanrange", + "type": "string" + }, + { + "description": "the ID of the guest VLAN range", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the guest vlan range", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the guest VLAN range", + "name": "domainid", + "type": "string" + }, + { + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" + }, + { + "description": "the project name of the guest vlan range", + "name": "project", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the account of the guest VLAN range", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the guest VLAN range", + "name": "domain", + "type": "string" + }, + {} + ] + }, + { + "description": "Adds VM to specified network by creating a NIC", + "isasync": true, + "name": "addNicToVirtualMachine", + "params": [ + { + "description": "IP Address for the new network", + "length": 255, + "name": "ipaddress", + "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,importUnmanagedInstance", + "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, + "name": "dhcpoptions", + "required": false, + "type": "map" + }, + { + "description": "Mac Address for the new network", + "length": 255, + "name": "macaddress", + "required": false, + "type": "string" + }, + { + "description": "Network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "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,importUnmanagedInstance", + "response": [ + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "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 account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "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" + } + ], + "type": "set" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "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 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 name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + {}, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "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", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "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": "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": "publicipid", + "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": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the 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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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 vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "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": "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": "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": "resource type", + "name": "resourcetype", + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the name of the 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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "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", + "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 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": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "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 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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ", - "name": "memorywithoverprovisioning", + "description": "the ID of 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 CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "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 ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, {}, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, - { - "description": "the name of the host", - "name": "name", - "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 host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if migrating a vm to this host requires storage motion, false otherwise", - "name": "requiresStorageMotion", + "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 cpu average load on the host", - "name": "averageload", - "type": "long" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" - }, - { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the Zone name of the host", - "name": "zonename", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" } ] }, { - "description": "Enable a Cisco Nexus VSM device", - "isasync": true, - "name": "enableCiscoNexusVSM", + "description": "Lists all static routes", + "isasync": false, + "name": "listStaticRoutes", "params": [ { - "description": "Id of the Cisco Nexus 1000v VSM device to be enabled", + "description": "", "length": 255, - "name": "id", - "related": "listCiscoNexusVSMs,enableCiscoNexusVSM,disableCiscoNexusVSM", - "required": true, - "type": "uuid" - } - ], - "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", - "response": [ - { - "description": "device state", - "name": "vsmdevicestate", - "type": "string" - }, - { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", - "type": "string" - }, - { - "description": "The 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", - "name": "vsmdevicestate", - "type": "string" - }, - { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", - "type": "string" - }, - { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" - }, - { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" - }, - { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" - }, - {}, - {}, - { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", - "type": "string" - }, - { - "description": "device name", - "name": "vsmdevicename", - "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 Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", - "type": "string" - } - ] - }, - { - "description": "Dedicates a guest vlan range to an account", - "isasync": false, - "name": "dedicateGuestVlanRange", - "params": [ - { - "description": "domain ID of the account owning a VLAN", + "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": "physical network ID of the vlan", + "description": "list static routes by gateway id", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway", + "required": false, "type": "uuid" }, { - "description": "project who will own the VLAN", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "account who will own the VLAN", + "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": "guest vlan range to be dedicated", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "vlanrange", - "required": true, - "type": "string" - } - ], - "related": "listDedicatedGuestVlanRanges", - "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 of the guest vlan range", - "name": "zoneid", - "type": "long" - }, - { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", - "type": "string" - }, - { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" - }, - {}, - { - "description": "the project name of the guest vlan range", - "name": "project", - "type": "string" - }, - {}, - { - "description": "the domain name of the guest VLAN range", - "name": "domain", - "type": "string" - }, - { - "description": "the account of the guest VLAN range", - "name": "account", - "type": "string" + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the guest VLAN range", + "description": "list static route by id", + "length": 255, "name": "id", - "type": "string" + "related": "listStaticRoutes", + "required": false, + "type": "uuid" }, { - "description": "the project id of the guest vlan range", - "name": "projectid", - "type": "string" - } - ] - }, - { - "description": "Adds VM to specified network by creating a NIC", - "isasync": true, - "name": "addNicToVirtualMachine", - "params": [ - { - "description": "IP Address for the new network", + "description": "", "length": 255, - "name": "ipaddress", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Mac Address for the new network", + "description": "list static routes by state", "length": 255, - "name": "macaddress", + "name": "state", "required": false, "type": "string" }, { - "description": "Virtual Machine ID", + "description": "list static routes by vpc id", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, "type": "uuid" }, { - "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "dhcpoptions", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "Network ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, "type": "uuid" } ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "related": "", "response": [ + {}, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "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 project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the disk offering of the virtual machine", - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "VPC gateway the route is created for", + "name": "gatewayid", "type": "string" }, - {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of static route", + "name": "id", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the ID of the domain associated with the static route", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with static route", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -35829,23 +38997,23 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -35854,192 +39022,372 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the state of the static route", + "name": "state", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the project name of the static route", + "name": "project", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the account associated with the static route", + "name": "account", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "static route CIDR", + "name": "cidr", + "type": "string" }, + {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the domain associated with the static route", + "name": "domain", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the project id of the static route", + "name": "projectid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists all public ip addresses", + "isasync": false, + "name": "listPublicIpAddresses", + "params": [ + { + "description": "lists all public IP addresses by zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "list only source NAT IP addresses", + "length": 255, + "name": "issourcenat", + "required": false, + "type": "boolean" }, - {}, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "List IPs belonging to the VPC", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "list only IPs used for load balancing", + "length": 255, + "name": "forloadbalancing", + "required": false, + "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "limits search results to allocated public IP addresses", + "length": 255, + "name": "allocatedonly", + "required": false, + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "lists all public IP addresses by VLAN ID", + "length": 255, + "name": "vlanid", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "lists IP address by ID", + "length": 255, + "name": "id", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "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" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "lists the specified IP address", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "list only static NAT IP addresses", + "length": 255, + "name": "isstaticnat", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "lists all public IP addresses by source network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "since": "4.13.0", + "type": "uuid" + }, + { + "description": "lists all public IP addresses by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "lists all public IP addresses by physical network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "the virtual network for the IP address", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" + } + ], + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "response": [ + { + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", + "description": "the name of the zone the public IP address belongs to", "name": "zonename", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "public IP address id", + "name": "id", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "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 total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinename", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "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 id associated with vm via Static nat rule", - "name": "publicip", + "description": "is public IP portable across the zones", + "name": "isportable", + "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 address", + "name": "project", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { @@ -36048,754 +39396,482 @@ "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the VLAN associated with the IP address", + "name": "vlanname", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", + "type": "string" + }, + { + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "type": "string" + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the list of resource tags associated with ip address", + "name": "tags", "response": [ { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the 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 traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, + {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachineid", + "type": "string" + } + ] + }, + { + "description": "Updates an ISO file.", + "isasync": false, + "name": "updateIso", + "params": [ + { + "description": "the name of the image file", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "true if the template type is routing i.e., if template is used to deploy router", + "length": 255, + "name": "isrouting", + "required": false, + "type": "boolean" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, - {}, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "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 entity/resource has annotations", - "name": "hasannotations", + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", + "required": false, "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the image file", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" + }, + { + "description": "the format for the image", + "length": 255, + "name": "format", + "required": false, "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, "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 account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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 list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the 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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the 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" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" + "description": "the ID of the OS type that best represents the OS of this image.", + "length": 255, + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", + "required": false, + "type": "uuid" + } + ], + "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "response": [ + { + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "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": "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": "true if vm 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 name of the host for the virtual machine", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", "name": "hostname", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" - } - ] - }, - { - "description": "Lists all static routes", - "isasync": false, - "name": "listStaticRoutes", - "params": [ + }, { - "description": "list static routes by vpc id", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "list static routes by state", - "length": 255, - "name": "state", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list static route by id", - "length": 255, - "name": "id", - "related": "listStaticRoutes", - "required": false, - "type": "uuid" + "description": "the account id to which the template belongs", + "name": "accountid", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, + "description": "the project id of the template", "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "list static routes by gateway id", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway", - "required": false, - "type": "uuid" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "additional key/value details tied with template", + "name": "details", "type": "map" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, { - "description": "the project id of the static route", - "name": "projectid", + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, {}, { - "description": "the list of resource tags associated with static route", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "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 list of resource tags associated", "name": "tags", "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -36804,791 +39880,1150 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the domain associated with the static route", - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists OpenDyalight controllers", + "isasync": false, + "name": "listOpenDaylightControllers", + "params": [ + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of a OpenDaylight Controller", + "length": 255, + "name": "id", + "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", + "required": false, + "type": "uuid" + } + ], + "related": "addOpenDaylightController,deleteOpenDaylightController", + "response": [ + { + "description": "the name assigned to the controller", + "name": "name", + "type": "string" + }, + { + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "device id of the controller", + "name": "id", "type": "string" }, {}, + { + "description": "the username to authenticate to the controller", + "name": "username", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain associated with the static route", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the static route", - "name": "state", + "description": "the url of the controller api", + "name": "url", + "type": "string" + }, + {} + ] + }, + { + "description": "Adds a BigSwitch BCF Controller device", + "isasync": true, + "name": "addBigSwitchBcfDevice", + "params": [ + { + "description": "Username of the BigSwitch BCF Controller.", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the account associated with the static route", - "name": "account", + "description": "Password of the BigSwitch BCF Controller.", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the ID of static route", - "name": "id", + "description": "Hostname of ip address of the BigSwitch BCF Controller.", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "NAT support of the BigSwitch BCF Controller.", + "length": 255, + "name": "nat", + "required": true, + "type": "boolean" + } + ], + "related": "listBigSwitchBcfDevices", + "response": [ + { + "description": "the controller username", + "name": "username", + "type": "string" + }, + { + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + {}, + { + "description": "device name", + "name": "bigswitchdevicename", + "type": "string" + }, + { + "description": "the controller Ip address", + "name": "hostname", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the controller password", + "name": "password", + "type": "string" + }, + { + "description": "NAT support", + "name": "nat", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.6.0" + }, + { + "description": "Deletes a counter for VM auto scaling", + "isasync": true, + "name": "deleteCounter", + "params": [ + { + "description": "the ID of the counter", + "length": 255, + "name": "id", + "related": "createCounter,listCounters", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the project name of the static route", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "static route CIDR", - "name": "cidr", - "type": "string" - } + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ] }, { - "description": "Lists all public ip addresses", - "isasync": false, - "name": "listPublicIpAddresses", + "description": "Changes the default NIC on a VM", + "isasync": true, + "name": "updateDefaultNicForVirtualMachine", "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": "Virtual Machine ID", "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "NIC ID", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "nicid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "lists all public IP addresses by physical network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "lists the specified IP address", - "length": 255, - "name": "ipaddress", - "required": false, + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "List IPs belonging to the VPC", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "lists all public IP addresses by state", - "length": 255, - "name": "state", - "required": false, + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the virtual network for the IP address", - "length": 255, - "name": "forvirtualnetwork", - "required": false, + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "list only IPs used for load balancing", - "length": 255, - "name": "forloadbalancing", - "required": false, - "type": "boolean" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "list only source NAT IP addresses", - "length": 255, - "name": "issourcenat", - "required": false, - "type": "boolean" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "lists all public IP addresses by zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "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,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "lists all public IP addresses by source network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.13.0", - "type": "uuid" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "lists all public IP addresses by VLAN ID", - "length": 255, - "name": "vlanid", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", - "required": false, - "type": "uuid" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "limits search results to allocated public IP addresses", - "length": 255, - "name": "allocatedonly", - "required": false, - "type": "boolean" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "list only static NAT IP addresses", - "length": 255, - "name": "isstaticnat", - "required": false, - "type": "boolean" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "lists IP address by ID", - "length": 255, - "name": "id", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - } - ], - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "response": [ - { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the 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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "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" + } + ], + "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 id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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 name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + } + ], + "type": "set" }, { - "description": "public IP address id", - "name": "id", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "public IP address", - "name": "ipaddress", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachineid", + "description": "the project id of the vm", + "name": "projectid", "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 userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinename", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, - {}, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "description": "the state of the virtual machine", "name": "state", "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "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", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the list of resource tags associated with ip address", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "tag value", - "name": "value", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" - } - ], - "type": "list" - }, - { - "description": "VPC id the ip belongs to", - "name": "vpcid", - "type": "string" - } - ] - }, - { - "description": "Updates an ISO file.", - "isasync": false, - "name": "updateIso", - "params": [ - { - "description": "the format for the image", - "length": 255, - "name": "format", - "required": false, - "type": "string" - }, - { - "description": "the ID of the OS type that best represents the OS of this image.", - "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" - }, - { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" - }, - { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" - }, - { - "description": "the name of the image file", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "sort key of the template, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the image file", - "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" - }, - { - "description": "true if the image supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" - }, - { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" - }, - { - "description": "true if image is bootable, false otherwise; available only for updateIso API", - "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" - }, - { - "description": "true if the template type is routing i.e., if template is used to deploy router", - "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" - }, - { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", - "length": 255, - "name": "cleanupdetails", - "required": false, - "type": "boolean" - } - ], - "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "response": [ - { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "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 template ID", - "name": "id", - "type": "string" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - {}, - { - "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 template name", - "name": "name", - "type": "string" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the type of the template", - "name": "templatetype", - "type": "string" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the size of the template", - "name": "size", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "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": "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 virtual machine", + "name": "id", + "type": "string" }, + {}, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the template display text", - "name": "displaytext", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "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 account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - {}, - { - "description": "the project name of the template", - "name": "project", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "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 account associated with the virtual machine", + "name": "account", "type": "string" }, + {}, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "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", "response": [ { - "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" }, { @@ -37607,8 +41042,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -37617,159 +41052,151 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "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" } ], "type": "set" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the group name of the virtual machine", + "name": "group", + "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 ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "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": "ssh key-pairs", + "name": "keypairs", "type": "string" } ] }, { - "description": "Lists OpenDyalight controllers", + "description": "Deletes a user for an account", "isasync": false, - "name": "listOpenDaylightControllers", + "name": "deleteUser", "params": [ { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of a OpenDaylight Controller", + "description": "id of the user to be deleted", "length": 255, "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", - "required": false, + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, "type": "uuid" } ], - "related": "addOpenDaylightController,deleteOpenDaylightController", "response": [ { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the username to authenticate to the controller", - "name": "username", - "type": "string" - }, - { - "description": "device id of the controller", - "name": "id", - "type": "string" - }, - { - "description": "the name assigned to the controller", - "name": "name", - "type": "string" - }, - { - "description": "the url of the controller api", - "name": "url", - "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", @@ -37778,59 +41205,45 @@ }, {}, { - "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": "Adds a BigSwitch BCF Controller device", + "description": "Initiates the specified power action to the host's out-of-band management interface", "isasync": true, - "name": "addBigSwitchBcfDevice", + "name": "issueOutOfBandManagementPowerAction", "params": [ { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "NAT support of the BigSwitch BCF Controller.", - "length": 255, - "name": "nat", - "required": true, - "type": "boolean" - }, - { - "description": "Password of the BigSwitch BCF Controller.", + "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", "length": 255, - "name": "password", + "name": "action", "required": true, "type": "string" }, { - "description": "Hostname of ip address of the BigSwitch BCF Controller.", + "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", "length": 255, - "name": "hostname", - "required": true, - "type": "string" + "name": "timeout", + "required": false, + "type": "long" }, { - "description": "Username of the BigSwitch BCF Controller.", + "description": "the ID of the host", "length": 255, - "name": "username", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "listBigSwitchBcfDevices", + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster", "response": [ { - "description": "the controller username", - "name": "username", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { @@ -37839,13 +41252,29 @@ "type": "string" }, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "device name", - "name": "bigswitchdevicename", + "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 operation result", + "name": "status", + "type": "boolean" + }, + {}, + { + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { @@ -37853,62 +41282,123 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "NAT support", - "name": "nat", - "type": "boolean" + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, {}, { - "description": "the controller password", + "description": "the out-of-band management interface password", "name": "password", "type": "string" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" } ], - "since": "4.6.0" + "since": "4.9.0" }, { - "description": "Deletes a counter", + "description": "Issues a client certificate using configured or provided CA plugin", "isasync": true, - "name": "deleteCounter", + "name": "issueCertificate", "params": [ { - "description": "the ID of the counter", + "description": "Comma separated list of IP addresses, the certificate should be issued for", "length": 255, - "name": "id", - "related": "createCounter,listCounters", - "required": true, - "type": "uuid" + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN", + "length": 255, + "name": "domain", + "required": false, + "type": "string" + }, + { + "description": "Certificate validity duration in number of days, when not provided the default configured value will be used", + "length": 255, + "name": "duration", + "required": false, + "type": "integer" + }, + { + "description": "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": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "length": 255, + "name": "provider", + "required": false, + "type": "string" } ], + "related": "listCaCertificate", "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": "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" + } + ], + "since": "4.11.0" + }, + { + "description": "Deletes network device.", + "isasync": false, + "name": "deleteNetworkDevice", + "params": [ + { + "description": "Id of network device to delete", + "length": 255, + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -37919,1099 +41409,689 @@ "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": "Changes the default NIC on a VM", - "isasync": true, - "name": "updateDefaultNicForVirtualMachine", + "description": "Updates image store read-only status", + "isasync": false, + "name": "updateImageStore", "params": [ { - "description": "NIC ID", + "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", "length": 255, - "name": "nicid", - "related": "", + "name": "readonly", "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "Virtual Machine ID", + "description": "Image Store UUID", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "id", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": true, "type": "uuid" } ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "related": "addSecondaryStorage,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ + {}, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the url of the image store", + "name": "url", + "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the ID of the image store", + "name": "id", "type": "string" }, - {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "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" - }, - { - "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" - } - ], - "type": "set" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "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 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" - } - ], - "type": "set" + "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 name of the image store", + "name": "name", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the Zone name of the image store", + "name": "zonename", + "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" + } + ], + "since": "4.15.0" + }, + { + "description": "Creates a port forwarding rule", + "isasync": true, + "name": "createPortForwardingRule", + "params": [ + { + "description": "the IP address id of the port forwarding rule", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "VM guest nic secondary IP address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "the ending port of port forwarding rule's private port range", + "length": 255, + "name": "publicendport", + "required": false, + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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,importUnmanagedInstance", + "required": true, + "type": "uuid" + }, + { + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true", + "length": 255, + "name": "openfirewall", + "required": false, + "type": "boolean" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "length": 255, + "name": "publicport", + "required": true, "type": "integer" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ending port of port forwarding rule's private port range", + "length": 255, + "name": "privateendport", + "required": false, + "type": "integer" + }, + { + "description": "the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "length": 255, + "name": "privateport", + "required": true, + "type": "integer" + } + ], + "related": "listPortForwardingRules,updatePortForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", + "response": [ + {}, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the 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 name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], - "type": "set" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "type": "list" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "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", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the ID of the availablility 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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, - {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + } + ] + }, + { + "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", + "required": true, + "type": "uuid" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" }, - {}, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "zone ID of the template to be prepared in primary storage(s).", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the zone for this template", + "name": "zonename", "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", + "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 pool type of the virtual machine", - "name": "pooltype", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "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 template ID", + "name": "id", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the type of the template", + "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 project id of the template", + "name": "projectid", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the 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": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, - { - "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 domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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 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": "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 id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "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 account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "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": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "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 account id to which the template belongs", + "name": "accountid", + "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 description of the security group", - "name": "description", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag 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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - } - ] - }, - { - "description": "Deletes a user for an account", - "isasync": false, - "name": "deleteUser", - "params": [ - { - "description": "id of the user to be deleted", - "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, - "type": "uuid" - } - ], - "response": [ {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" - } - ] - }, - { - "description": "Initiates the specified power action to the host's out-of-band management interface", - "isasync": true, - "name": "issueOutOfBandManagementPowerAction", - "params": [ + }, { - "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", - "length": 255, - "name": "action", - "required": true, + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", - "length": 255, - "name": "timeout", - "required": false, - "type": "long" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "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 template name", + "name": "name", + "type": "string" + }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, - {}, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the template display text", + "name": "displaytext", "type": "string" }, { @@ -39020,177 +42100,147 @@ "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, - {}, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" } - ], - "since": "4.9.0" + ] }, { - "description": "Issues a client certificate using configured or provided CA plugin", + "description": "Dedicates a zones.", "isasync": true, - "name": "issueCertificate", + "name": "dedicateZone", "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": "Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN", + "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, - "name": "domain", + "name": "account", "required": false, "type": "string" }, { - "description": "Comma separated list of IP addresses, the certificate should be issued for", + "description": "the ID of the containing domain", "length": 255, - "name": "ipaddress", - "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", - "required": false, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": true, + "type": "uuid" }, { - "description": "Certificate validity duration in number of days, when not provided the default configured value will be used", + "description": "the ID of the zone", "length": 255, - "name": "duration", - "required": false, - "type": "integer" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" } ], - "related": "listCaCertificate", + "related": "", "response": [ { - "description": "The client certificate", - "name": "certificate", + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, { - "description": "Private key for the certificate", - "name": "privatekey", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, {}, { - "description": "The CA certificate(s)", - "name": "cacertificates", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Name of the Zone", + "name": "zonename", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ], - "since": "4.11.0" - }, - { - "description": "Deletes network device.", - "isasync": false, - "name": "deleteNetworkDevice", - "params": [ + }, { - "description": "Id of network device to delete", - "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", + "type": "string" + }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, { - "description": "Updates image store read-only status", - "isasync": false, - "name": "updateImageStore", + "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", + "isasync": true, + "name": "assignToLoadBalancerRule", "params": [ { - "description": "Image Store UUID", + "description": "the ID of the load balancer rule", "length": 255, "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "related": "listPortForwardingRules,updatePortForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" }, { - "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", + "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", "length": 255, - "name": "readonly", - "required": true, - "type": "boolean" + "name": "vmidipmap", + "required": false, + "since": "4.4", + "type": "map" + }, + { + "description": "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", + "length": 255, + "name": "virtualmachineids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": false, + "type": "list" } ], - "related": "addSecondaryStorage,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the provider name of the image store", - "name": "providername", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, @@ -39199,252 +42249,134 @@ "name": "jobstatus", "type": "integer" }, - { - "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 ID of the image store", - "name": "id", - "type": "string" - }, - { - "description": "the url of the image store", - "name": "url", - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the image store", - "name": "name", - "type": "string" - }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" } - ], - "since": "4.15.0" + ] }, { - "description": "Creates a port forwarding rule", - "isasync": true, - "name": "createPortForwardingRule", + "description": "Lists all pending asynchronous jobs for the account.", + "isasync": false, + "name": "listAsyncJobs", "params": [ { - "description": "VM guest nic secondary IP address for the port forwarding rule", + "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", "length": 255, - "name": "vmguestip", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { - "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", + "description": "List by keyword", "length": 255, - "name": "protocol", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created 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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "openfirewall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "the ID of the virtual machine for the port forwarding rule", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - }, - { - "description": "the ending port of port forwarding rule's private port range", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "publicendport", + "name": "listall", "required": false, - "type": "integer" - }, - { - "description": "the IP address id of the port forwarding rule", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "length": 255, - "name": "publicport", - "required": true, - "type": "integer" + "type": "boolean" }, { - "description": "the starting port of port forwarding rule's private port range", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "privateport", - "required": true, - "type": "integer" + "name": "account", + "required": false, + "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", + "description": "", "length": 255, - "name": "privateendport", + "name": "page", "required": false, "type": "integer" }, { - "description": "the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "", "length": 255, - "name": "fordisplay", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" } ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", + "related": "queryAsyncJobResult", "response": [ + {}, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" }, { - "description": "the state of the rule", - "name": "state", + "description": "the user that executed the async command", + "name": "userid", "type": "string" }, + {}, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" + }, + { + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the account that executed the async command", + "name": "accountid", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the result type", + "name": "jobresulttype", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "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 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": "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 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" - } - ], - "type": "list" + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" + }, + { + "description": " the created date of the job", + "name": "created", + "type": "date" }, { "description": "the current status of the latest async job acting on this object", @@ -39452,822 +42384,713 @@ "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - {}, + "description": " the completed date of the job", + "name": "completed", + "type": "date" + } + ] + }, + { + "description": "Archive one or more alerts.", + "isasync": false, + "name": "archiveAlerts", + "params": [ { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" + "description": "end date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" + "description": "start date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "archive by alert type", + "length": 255, + "name": "type", + "required": false, "type": "string" }, + { + "description": "the IDs of the alerts", + "length": 255, + "name": "ids", + "related": "listAlerts", + "required": false, + "type": "list" + } + ], + "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" } ] }, { - "description": "load template into primary storage", + "description": "Deletes a Cisco Vnmc controller", "isasync": false, - "name": "prepareTemplate", + "name": "deleteCiscoVnmcResource", "params": [ { - "description": "template ID of the template to be prepared in primary storage(s).", - "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" - }, - { - "description": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" - }, - { - "description": "zone ID of the template to be prepared in primary storage(s).", + "description": "Cisco Vnmc resource ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "resourceid", + "related": "listCiscoVnmcResources", "required": true, "type": "uuid" } ], - "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "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", + "description": "any text associated with the success or failure", + "name": "displaytext", "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": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Stops an Internal LB vm.", + "isasync": true, + "name": "stopInternalLoadBalancerVM", + "params": [ { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "Force stop the VM. The caller knows the VM is stopped.", + "length": 255, + "name": "forced", + "required": false, "type": "boolean" }, { - "description": "the template ID", + "description": "the ID of the internal lb vm", + "length": 255, "name": "id", - "type": "string" - }, + "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" + } + ], + "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "response": [ { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the name of the secondary storage host for the template", + "description": "the hostname for the router", "name": "hostname", "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 type of the template", - "name": "templatetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the template display text", - "name": "displaytext", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "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", - "name": "parenttemplateid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "tag value", - "name": "value", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ip address of the nic", + "name": "ipaddress", "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": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "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": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + } + ], + "type": "set" }, { - "description": "the date this template was removed", - "name": "removed", + "description": "the date and time the router was created", + "name": "created", "type": "date" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, {}, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ] - }, - { - "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": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the ID of the dedicated resource", + "description": "the id of the router", "name": "id", "type": "string" }, - {}, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the Name of the Zone", + "description": "the Zone name for the router", "name": "zonename", "type": "string" }, { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, - {}, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", - "isasync": true, - "name": "assignToLoadBalancerRule", - "params": [ - { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", - "length": 255, - "name": "vmidipmap", - "required": false, - "since": "4.4", - "type": "map" + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", - "required": true, - "type": "uuid" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { - "description": "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", - "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "type": "list" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, - {} - ] - }, - { - "description": "Lists all pending asynchronous jobs for the account.", - "isasync": false, - "name": "listAsyncJobs", - "params": [ { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "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 version of template", + "name": "version", + "type": "string" }, { - "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "tzdate" + "description": "the Pod name for the router", + "name": "podname", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "queryAsyncJobResult", - "response": [ - {}, - { - "description": "the async command executed", - "name": "cmd", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the result type", - "name": "jobresulttype", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": " the created date of the job", - "name": "created", - "type": "date" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, - {}, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the result code for the job", - "name": "jobresultcode", + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": " the completed date of the job", - "name": "completed", - "type": "date" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" + "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", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" }, { - "description": "the account that executed the async command", - "name": "accountid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" }, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" } ] }, { - "description": "Archive one or more alerts.", - "isasync": false, - "name": "archiveAlerts", + "description": "Adds a Brocade VCS Switch", + "isasync": true, + "name": "addBrocadeVcsDevice", "params": [ { - "description": "start date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "Credentials to access the Brocade VCS Switch API", "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "name": "username", + "required": true, + "type": "string" }, { - "description": "archive by alert type", + "description": "Credentials to access the Brocade VCS Switch API", "length": 255, - "name": "type", - "required": false, + "name": "password", + "required": true, "type": "string" }, { - "description": "end date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "the Physical Network ID", "length": 255, - "name": "enddate", - "required": false, - "type": "date" + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "the IDs of the alerts", + "description": "Hostname of ip address of the Brocade VCS Switch.", "length": 255, - "name": "ids", - "related": "listAlerts", - "required": false, - "type": "list" + "name": "hostname", + "required": true, + "type": "string" } ], + "related": "listBrocadeVcsDevices", "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the principal switch Ip address", + "name": "hostname", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Deletes a Cisco Vnmc controller", - "isasync": false, - "name": "deleteCiscoVnmcResource", - "params": [ - { - "description": "Cisco Vnmc resource ID", - "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "device name", + "name": "brocadedevicename", "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": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" } ] }, { - "description": "Stops an Internal LB vm.", - "isasync": true, - "name": "stopInternalLoadBalancerVM", + "description": "Updates a security group", + "isasync": false, + "name": "updateSecurityGroup", "params": [ { - "description": "Force stop the VM. The caller knows the VM is stopped.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the internal lb vm", + "description": "The ID of the security group.", "length": 255, "name": "id", - "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "related": "createSecurityGroup,updateSecurityGroup", "required": true, "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "response": [ - { - "description": "the id of the router", - "name": "id", - "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "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 public IP address for the router", - "name": "publicip", + "description": "The new name of the security group.", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, + } + ], + "related": "createSecurityGroup", + "response": [ { - "description": "the name of the router", - "name": "name", + "description": "the project name of the group", + "name": "project", "type": "string" }, + {}, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -40276,725 +43099,654 @@ "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the domain ID of the security group", + "name": "domainid", "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": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, + {}, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", - "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "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": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the project id of the group", + "name": "projectid", "type": "string" - }, + } + ], + "since": "4.14.0.0" + }, + { + "description": "Creates a domain", + "isasync": false, + "name": "createDomain", + "params": [ { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "Domain UUID, required for adding domain from another Region", + "length": 255, + "name": "domainid", + "required": false, "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.", + "length": 255, + "name": "parentdomainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "Network domain for networks in the domain", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "creates domain with this name", + "length": 255, + "name": "name", + "required": true, "type": "string" - }, + } + ], + "related": "listDomainChildren,listDomains,listDomains", + "response": [ { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, + {}, + {}, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the network domain for the router", + "description": "the network domain", "name": "networkdomain", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, - {}, { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the ID of the domain", + "name": "id", "type": "string" - } - ] - }, - { - "description": "Adds a Brocade VCS Switch", - "isasync": true, - "name": "addBrocadeVcsDevice", - "params": [ + }, { - "description": "Credentials to access the Brocade VCS Switch API", - "length": 255, - "name": "password", - "required": true, + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "Hostname of ip address of the Brocade VCS Switch.", - "length": 255, - "name": "hostname", - "required": true, + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "Credentials to access the Brocade VCS Switch API", - "length": 255, - "name": "username", - "required": true, + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - } - ], - "related": "listBrocadeVcsDevices", - "response": [ + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "the name of the domain", + "name": "name", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the principal switch Ip address", - "name": "hostname", - "type": "string" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "name of the provider", - "name": "provider", + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, - {}, { - "description": "device name", - "name": "brocadedevicename", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" } ] }, { - "description": "Updates a security group", - "isasync": false, - "name": "updateSecurityGroup", + "description": "Deleting resource tag(s)", + "isasync": true, + "name": "deleteTags", "params": [ { - "description": "The ID of the security group.", + "description": "Delete tags for resource id(s)", "length": 255, - "name": "id", - "related": "createSecurityGroup,updateSecurityGroup", + "name": "resourceids", "required": true, - "type": "uuid" + "type": "list" }, { - "description": "The new name of the security group.", + "description": "Delete tags matching key/value pairs", "length": 255, - "name": "name", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "Delete tag by resource type", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "name": "resourcetype", + "required": true, "type": "string" } ], - "related": "createSecurityGroup", "response": [ + {}, {}, { - "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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the 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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the 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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -41002,456 +43754,470 @@ "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 project name of the group", - "name": "project", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.0.0" + }, + { + "description": "create Tungsten-Fabric tag type", + "isasync": true, + "name": "createTungstenFabricTagType", + "params": [ + { + "description": "Tungsten-Fabric tag type name", + "length": 255, + "name": "name", + "required": true, "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - {} + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } ], - "since": "4.14.0.0" + "related": "listTungstenFabricTagType", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric tag type name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] }, { - "description": "Creates a domain", - "isasync": false, - "name": "createDomain", + "description": "Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules", + "isasync": true, + "name": "restartNetwork", "params": [ { - "description": "Domain UUID, required for adding domain from another Region", + "description": "Turn the network into a network with redundant routers.", "length": 255, - "name": "domainid", + "name": "makeredundant", "required": false, - "type": "string" + "since": "4.11.1", + "type": "boolean" }, { - "description": "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specied, the ROOT domain is assumed.", + "description": "The ID of the network to restart.", "length": 255, - "name": "parentdomainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, + "name": "id", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, "type": "uuid" }, { - "description": "Network domain for networks in the domain", + "description": "If cleanup old network elements", "length": 255, - "name": "networkdomain", + "name": "cleanup", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "creates domain with this name", + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "livepatch", + "required": false, + "since": "4.17.0", + "type": "boolean" } ], - "related": "listDomainChildren,listDomains,listDomains", "response": [ { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the level of the domain", - "name": "level", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the \"logout\" command has been issued or the session has expired.", + "isasync": false, + "name": "login", + "params": [ { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precendence", + "length": 255, + "name": "domainId", + "required": false, "type": "long" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "length": 255, + "name": "domain", + "required": false, "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "Username", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "length": 255, + "name": "password", + "required": true, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the account name the user belongs to", + "name": "account", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "Username", + "name": "username", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Is user registered", + "name": "registered", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" }, - {}, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "last name of the user", + "name": "lastname", "type": "string" }, + {}, + {}, { - "description": "the network domain", - "name": "networkdomain", + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", + "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "user time zone", + "name": "timezone", + "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "first name of the user", + "name": "firstname", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "Is two factor authentication verified", + "name": "is2faverified", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "User ID", + "name": "userid", + "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "user time zoneoffset", + "name": "timezoneoffset", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "Two factor authentication provider", + "name": "providerfor2fa", + "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists all hypervisor capabilities.", + "isasync": false, + "name": "listHypervisorCapabilities", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" + "description": "ID of the hypervisor capability", + "length": 255, + "name": "id", + "related": "listHypervisorCapabilities", + "required": false, + "type": "uuid" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "true if security group is supported", + "name": "securitygroupenabled", + "type": "boolean" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, + {}, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", - "type": "string" + "description": "the hypervisor type", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", - "type": "string" + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the ID of the hypervisor capabilities row", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if storage motion is supported", + "name": "storagemotionenabled", "type": "boolean" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" + } + ], + "since": "3.0.0" + }, + { + "description": "Adds backup image store.", + "isasync": false, + "name": "addImageStore", + "params": [ + { + "description": "the name for the image store", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the image store provider name", + "length": 255, + "name": "provider", + "required": true, + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the URL for the image store", + "length": 2048, + "name": "url", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "the Zone ID for the image store", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "addSecondaryStorage,listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "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 total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the url of the image store", + "name": "url", "type": "string" }, - {}, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" - } - ] - }, - { - "description": "Deleting resource tag(s)", - "isasync": true, - "name": "deleteTags", - "params": [ + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, { - "description": "Delete tags for resource id(s)", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "Delete tags matching key/value pairs", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the name of the image store", + "name": "name", + "type": "string" }, + {}, { - "description": "Delete tag by resource type", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "the protocol of the image store", + "name": "protocol", "type": "string" - } - ], - "response": [ + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, {}, { @@ -41460,40 +44226,33 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" - }, - {} + } ], - "since": "4.0.0" + "since": "4.2.0" }, { - "description": "List external firewall appliances.", + "description": "Revoke a direct download certificate from hosts in a zone", "isasync": false, - "name": "listExternalFirewalls", + "name": "revokeTemplateDirectDownloadCertificate", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "(optional) the host ID to revoke certificate", "length": 255, - "name": "pagesize", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "zone Id", + "description": "(optional) zone to revoke certificate", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -41501,63 +44260,45 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "(optional) hypervisor type", "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the ID of the network device", - "name": "id", - "type": "string" - }, - { - "description": "the username that's used to log in to the external firewall", - "name": "username", - "type": "string" - }, - { - "description": "the public interface of the external firewall", - "name": "publicinterface", - "type": "string" - }, - { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the ID of the external firewall", + "description": "id of the certificate", + "length": 255, "name": "id", - "type": "string" - }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" + "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", + "required": false, + "type": "uuid" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "(optional) alias of the SSL certificate", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "provisionTemplateDirectDownloadCertificate", + "response": [ + {}, + {}, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "indicates the details in case of failure or host skipped", + "name": "details", "type": "string" }, { @@ -41566,708 +44307,718 @@ "type": "integer" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", - "type": "string" - }, - { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the name of the host", + "name": "hostname", "type": "string" - }, - {}, - {} - ] + } + ], + "since": "4.13" }, { - "description": "Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules", - "isasync": true, - "name": "restartNetwork", + "description": "Syncs capabilities of storage pools", + "isasync": false, + "name": "updateStorageCapabilities", "params": [ { - "description": "The ID of the network to restart.", + "description": "Storage pool id", "length": 255, "name": "id", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" - }, - { - "description": "If cleanup old network elements", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" - }, - { - "description": "Turn the network into a network with redundant routers.", - "length": 255, - "name": "makeredundant", - "required": false, - "since": "4.11.1", - "type": "boolean" - }, - { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", - "length": 255, - "name": "livepatch", - "required": false, - "since": "4.17.0", - "type": "boolean" } ], + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "response": [ + { + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the \"logout\" command has been issued or the session has expired.", - "isasync": false, - "name": "login", - "params": [ - { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", - "length": 255, - "name": "domain", - "required": false, + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "Username", - "length": 255, - "name": "username", - "required": true, + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", - "length": 255, - "name": "password", - "required": true, + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precendence", - "length": 255, - "name": "domainId", - "required": false, + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" - } - ], - "related": "", - "response": [ + }, { - "description": "user time zone", - "name": "timezone", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the account name the user belongs to", - "name": "account", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, + {}, { - "description": "last name of the user", - "name": "lastname", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "first name of the user", - "name": "firstname", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Username", - "name": "username", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, - {}, { - "description": "Domain ID that the user belongs to", - "name": "domainid", + "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 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": "User ID", - "name": "userid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, {}, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the storage pool type", "name": "type", "type": "string" } - ] + ], + "since": "4.16.0" }, { - "description": "Lists all hypervisor capabilities.", + "description": "Delete Project roles in CloudStack", "isasync": false, - "name": "listHypervisorCapabilities", + "name": "deleteProjectRole", "params": [ { - "description": "", + "description": "ID of the project role to be deleted", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "id", + "related": "createProjectRole,listProjectRoles,updateProjectRole", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "ID of the project from where the role is to be deleted", "length": 255, - "name": "pagesize", - "required": false, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "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": "ID of the hypervisor capability", + "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.15.0" + }, + { + "description": "Changes ownership of a Volume from one account to another.", + "isasync": false, + "name": "assignVolume", + "params": [ + { + "description": "The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'.", "length": 255, - "name": "id", - "related": "listHypervisorCapabilities", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "the hypervisor for which to restrict the search", + "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", "length": 255, - "name": "hypervisor", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "The ID of the volume to be reassigned.", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "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": "", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ - { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" - }, { "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", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, - {}, { - "description": "the ID of the hypervisor capabilities row", - "name": "id", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "true if security group is supported", - "name": "securitygroupenabled", - "type": "boolean" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the maximum number of guest vms recommended for this hypervisor", - "name": "maxguestslimit", - "type": "long" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the hypervisor type", - "name": "hypervisor", - "type": "hypervisortype" - } - ], - "since": "3.0.0" - }, - { - "description": "Adds backup image store.", - "isasync": false, - "name": "addImageStore", - "params": [ + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" + }, + {}, { - "description": "the image store provider name", - "length": 255, - "name": "provider", - "required": true, + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the name for the image store", - "length": 255, - "name": "name", - "required": false, + "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 domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the URL for the image store", - "length": 2048, - "name": "url", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the Zone ID for the image store", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "addSecondaryStorage,listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "response": [ + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, - {}, { - "description": "the url of the image store", - "name": "url", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - } - ], - "since": "4.2.0" - }, - { - "description": "Revoke a direct download certificate from hosts in a zone", - "isasync": false, - "name": "revokeTemplateDirectDownloadCertificate", - "params": [ - { - "description": "(optional) hypervisor type", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "(optional) zone to revoke certificate", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "(optional) alias of the SSL certificate", - "length": 255, - "name": "name", - "required": false, + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "id of the certificate", - "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", - "required": false, - "type": "uuid" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "(optional) the host ID to revoke certificate", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": false, - "type": "uuid" - } - ], - "related": "provisionTemplateDirectDownloadCertificate", - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", + "description": "the disk utilization", + "name": "utilization", "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": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "the ID of 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", - "name": "hostid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, - {} - ], - "since": "4.13" - }, - { - "description": "Syncs capabilities of storage pools", - "isasync": false, - "name": "updateStorageCapabilities", - "params": [ - { - "description": "Storage pool id", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" - } - ], - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "response": [ { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, - {}, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "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": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "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", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" } ], - "since": "4.16.0" + "since": "4.18.0.0" }, { - "description": "Delete Project roles in CloudStack", + "description": "Deletes a userdata", "isasync": false, - "name": "deleteProjectRole", + "name": "deleteUserData", "params": [ { - "description": "ID of the project role to be deleted", + "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "id", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": true, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, "type": "uuid" }, { - "description": "ID of the project from where the role is to be deleted", + "description": "an optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "an optional project for the userdata", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Userdata", + "length": 255, + "name": "id", + "related": "", "required": true, "type": "uuid" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "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" + "since": "4.18" }, { "description": "Get SolidFire Account ID", @@ -42275,16 +45026,16 @@ "name": "getSolidFireAccountId", "params": [ { - "description": "Storage Pool UUID", + "description": "CloudStack Account UUID", "length": 255, - "name": "storageid", + "name": "accountid", "required": true, "type": "string" }, { - "description": "CloudStack Account UUID", + "description": "Storage Pool UUID", "length": 255, - "name": "accountid", + "name": "storageid", "required": true, "type": "string" } @@ -42296,13 +45047,13 @@ "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + {}, { "description": "SolidFire Account ID", "name": "solidFireAccountId", @@ -42327,23 +45078,24 @@ "related": "", "response": [ { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "the ID of the role permission", + "name": "id", "type": "string" }, + {}, { - "description": "the ID of the role permission", - "name": "id", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { @@ -42351,16 +45103,15 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" }, - {}, - {}, { - "description": "the description of the role permission", - "name": "description", + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", "type": "string" }, { @@ -42383,6 +45134,13 @@ "required": false, "type": "integer" }, + { + "description": "network service name to list providers and capabilities of", + "length": 255, + "name": "service", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -42397,13 +45155,6 @@ "required": false, "type": "string" }, - { - "description": "network service name to list providers and capabilities of", - "length": 255, - "name": "service", - "required": false, - "type": "string" - }, { "description": "List by keyword", "length": 255, @@ -42414,34 +45165,12 @@ ], "related": "", "response": [ - {}, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, { - "description": "the service name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the service provider name", "name": "provider", @@ -42451,11 +45180,6 @@ "name": "canenableindividualservice", "type": "boolean" }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { "description": "the provider name", "name": "name", @@ -42467,9 +45191,9 @@ "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", @@ -42480,21 +45204,48 @@ "description": "state of the network provider", "name": "state", "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], "type": "list" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -42513,28 +45264,28 @@ } ], "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on 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" + }, + {}, + {} ] }, { @@ -42543,107 +45294,108 @@ "name": "listDedicatedGuestVlanRanges", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", + "description": "project who will own the guest VLAN range", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the dedicated 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": "guestvlanrange", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list dedicated guest vlan ranges by id", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listDedicatedGuestVlanRanges", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "physical network id of the guest VLAN range", "length": 255, - "name": "keyword", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "project who will own the guest VLAN range", + "description": "zone of the guest VLAN range", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "list dedicated guest vlan ranges by id", + "description": "the dedicated guest vlan range", "length": 255, - "name": "id", - "related": "listDedicatedGuestVlanRanges", + "name": "guestvlanrange", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "physical network id of the guest VLAN range", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "zone of the guest VLAN range", + "description": "the account with which the guest VLAN 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 guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ + {}, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the project name of the guest vlan range", + "name": "project", "type": "string" }, - {}, { - "description": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the guest VLAN range", + "name": "id", + "type": "string" }, + {}, { "description": "the account of the guest VLAN range", "name": "account", "type": "string" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, { @@ -42651,17 +45403,6 @@ "name": "physicalnetworkid", "type": "long" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the ID of the guest VLAN range", - "name": "id", - "type": "string" - }, { "description": "the project id of the guest vlan range", "name": "projectid", @@ -42673,9 +45414,19 @@ "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" } ] }, @@ -42684,6 +45435,13 @@ "isasync": true, "name": "addNetworkServiceProvider", "params": [ + { + "description": "the list of services to be enabled for this physical network service provider", + "length": 255, + "name": "servicelist", + "required": false, + "type": "list" + }, { "description": "the destination Physical Network ID to bridge to", "length": 255, @@ -42706,22 +45464,10 @@ "name": "name", "required": true, "type": "string" - }, - { - "description": "the list of services to be enabled for this physical network service provider", - "length": 255, - "name": "servicelist", - "required": false, - "type": "list" } ], "related": "listNetworkServiceProviders,listTrafficTypes", "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, {}, { "description": "uuid of the network provider", @@ -42729,13 +45475,18 @@ "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 provider name", - "name": "name", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -42744,9 +45495,9 @@ "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 destination physical network", @@ -42754,15 +45505,15 @@ "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": "the provider name", + "name": "name", + "type": "string" } ], "since": "3.0.0" @@ -42773,56 +45524,64 @@ "name": "listNetworkACLs", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "list network ACL items by ACL ID", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, "type": "uuid" }, { - "description": "list network ACL items by traffic type - ingress or egress", + "description": "list network ACL items by network ID", "length": 255, - "name": "traffictype", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "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 resources by tags (key/value pairs)", "length": 255, - "name": "isrecursive", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list network ACL items by network ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "fordisplay", + "name": "isrecursive", "required": false, - "since": "4.4", "type": "boolean" }, { @@ -42833,146 +45592,83 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "list network ACL items by protocol", "length": 255, - "name": "pagesize", + "name": "protocol", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Lists network ACL Item with the specified 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": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list network ACL items by action", "length": 255, - "name": "account", + "name": "action", "required": false, "type": "string" }, { - "description": "list network ACL items by ACL ID", + "description": "Lists network ACL Item with the specified ID", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "id", + "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", "required": false, "type": "uuid" }, { - "description": "list network ACL items by action", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "action", + "name": "account", "required": false, "type": "string" }, { - "description": "list network ACL items by protocol", + "description": "list network ACL items by traffic type - ingress or egress", "length": 255, - "name": "protocol", + "name": "traffictype", "required": false, "type": "string" } ], "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", "response": [ + {}, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "list" + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" }, { "description": "the traffic type for the ACL", "name": "traffictype", "type": "string" }, + {}, { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { @@ -42985,16 +45681,30 @@ "name": "aclid", "type": "string" }, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "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": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { "description": "an explanation on why this ACL rule is being applied", @@ -43007,35 +45717,76 @@ "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, + { + "description": "the list of resource tags associated with the network ACLs", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + }, { "description": "the state of the rule", "name": "state", "type": "string" - }, - { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" } ] }, @@ -43054,23 +45805,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": "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", @@ -43084,35 +45835,33 @@ "name": "createServiceOffering", "params": [ { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", + "name": "bytesreadratemax", "required": false, - "since": "4.15", - "type": "uuid" + "type": "long" }, { - "description": "burst bytes write rate of the disk offering", + "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": "byteswriteratemax", + "name": "deploymentplanner", "required": false, - "type": "long" + "type": "string" }, { - "description": "The maximum number of CPUs to be set with Custom Computer Offering", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "maxcpunumber", + "name": "byteswriterate", "required": false, - "since": "4.13", - "type": "integer" + "type": "long" }, { - "description": "burst io requests write rate of the disk offering", + "description": "The minimum memory size of the custom service offering in MB", "length": 255, - "name": "iopswriteratemax", + "name": "minmemory", "required": false, - "type": "long" + "since": "4.13", + "type": "integer" }, { "description": "restrict the CPU usage to committed service offering", @@ -43122,18 +45871,18 @@ "type": "boolean" }, { - "description": "bytes write rate of the disk offering", + "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": "byteswriterate", + "name": "diskofferingstrictness", "required": false, - "type": "long" + "since": "4.17", + "type": "boolean" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "the total memory of the service offering in MB", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "memory", "required": false, - "since": "4.4", "type": "integer" }, { @@ -43144,20 +45893,36 @@ "type": "long" }, { - "description": "the name of the service offering", + "description": "the CPU number of the service offering", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "cpunumber", + "required": false, + "type": "integer" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "Whether service offering size is custom or not", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "customized", "required": false, "since": "4.13", - "type": "list" + "type": "boolean" + }, + { + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "length": 255, + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", + "required": false, + "since": "4.15", + "type": "uuid" + }, + { + "description": "max iops of the compute offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.4", + "type": "long" }, { "description": "The maximum memory size of the custom service offering in MB", @@ -43168,34 +45933,44 @@ "type": "integer" }, { - "description": "the Root disk size in GB.", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "rootdisksize", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.15", - "type": "long" + "since": "4.13", + "type": "list" }, { - "description": "the HA for the service offering", + "description": "whether compute offering iops is custom or not", "length": 255, - "name": "offerha", + "name": "customizediops", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the total memory of the service offering in MB", + "description": "The minimum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "memory", + "name": "mincpunumber", "required": false, + "since": "4.13", "type": "integer" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "description": "the name of the service offering", "length": 255, - "name": "dynamicscalingenabled", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the Root disk size in GB.", + "length": 255, + "name": "rootdisksize", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.15", + "type": "long" }, { "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", @@ -43205,39 +45980,40 @@ "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "iopswriteratemaxlength", + "name": "byteswriteratemax", "required": false, "type": "long" }, { - "description": "true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "isvolatile", + "name": "provisioningtype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "is this a system vm offering", "length": 255, - "name": "provisioningtype", + "name": "issystem", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "io requests write rate of the disk offering", + "description": "the HA for the service offering", "length": 255, - "name": "iopswriterate", + "name": "offerha", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "description": "VMs using this offering require root volume encryption", "length": 255, - "name": "networkrate", + "name": "encryptroot", "required": false, - "type": "integer" + "since": "4.18", + "type": "boolean" }, { "description": "the ID of the disk offering to which service offering should be mapped", @@ -43248,6 +46024,14 @@ "since": "4.17", "type": "uuid" }, + { + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "length": 255, + "name": "cachemode", + "required": false, + "since": "4.14", + "type": "string" + }, { "description": "length (in seconds) of the burst", "length": 255, @@ -43256,25 +46040,26 @@ "type": "long" }, { - "description": "the host tag for this service offering.", + "description": "the CPU speed of the service offering in MHz.", "length": 255, - "name": "hosttags", + "name": "cpuspeed", "required": false, - "type": "string" + "type": "integer" }, { - "description": "length (in seconds) of the burst", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "iopsreadratemaxlength", + "name": "hypervisorsnapshotreserve", "required": false, - "type": "long" + "since": "4.4", + "type": "integer" }, { - "description": "burst bytes read rate of the disk offering", + "description": "details for planner, used to store specific parameters", "length": 255, - "name": "bytesreadratemax", + "name": "serviceofferingdetails", "required": false, - "type": "long" + "type": "map" }, { "description": "the display text of the service offering", @@ -43284,50 +46069,40 @@ "type": "string" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "length": 255, - "name": "diskofferingstrictness", - "required": false, - "since": "4.17", - "type": "boolean" - }, - { - "description": "The minimum 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": "minmemory", + "name": "networkrate", "required": false, - "since": "4.13", "type": "integer" }, { - "description": "the tags for this service offering.", + "description": "length (in seconds) of the burst", "length": 255, - "name": "tags", + "name": "iopswriteratemaxlength", "required": false, - "type": "string" + "type": "long" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "iopswriterate", "required": false, - "type": "list" + "type": "long" }, { - "description": "Whether service offering size is custom or not", + "description": "length (in seconds) of the burst", "length": 255, - "name": "customized", + "name": "byteswriteratemaxlength", "required": false, - "since": "4.13", - "type": "boolean" + "type": "long" }, { - "description": "the CPU number of the service offering", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", "length": 255, - "name": "cpunumber", + "name": "dynamicscalingenabled", "required": false, - "type": "integer" + "since": "4.16", + "type": "boolean" }, { "description": "burst requests read rate of the disk offering", @@ -43337,34 +46112,25 @@ "type": "long" }, { - "description": "max iops of the compute offering", - "length": 255, - "name": "maxiops", - "required": false, - "since": "4.4", - "type": "long" - }, - { - "description": "min iops of the compute offering", + "description": "true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM", "length": 255, - "name": "miniops", + "name": "isvolatile", "required": false, - "since": "4.4", - "type": "long" + "type": "boolean" }, { - "description": "is this a system vm offering", + "description": "the host tag for this service offering.", "length": 255, - "name": "issystem", + "name": "hosttags", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "byteswriteratemaxlength", + "name": "storagetype", "required": false, - "type": "long" + "type": "string" }, { "description": "io requests read rate of the disk offering", @@ -43374,74 +46140,56 @@ "type": "long" }, { - "description": "the CPU speed of the service offering in MHz.", + "description": "length (in seconds) of the burst", "length": 255, - "name": "cpuspeed", + "name": "iopsreadratemaxlength", "required": false, - "type": "integer" + "type": "long" }, { - "description": "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used", + "description": "the tags for this service offering.", "length": 255, - "name": "deploymentplanner", + "name": "tags", "required": false, "type": "string" }, { - "description": "details for planner, used to store specific parameters", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "serviceofferingdetails", + "name": "iopswriteratemax", "required": false, - "type": "map" + "type": "long" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "min iops of the compute offering", "length": 255, - "name": "storagetype", + "name": "miniops", "required": false, - "type": "string" + "since": "4.4", + "type": "long" }, { - "description": "The minimum number of CPUs to be set with Custom Computer Offering", + "description": "The maximum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "mincpunumber", + "name": "maxcpunumber", "required": false, "since": "4.13", "type": "integer" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "length": 255, - "name": "cachemode", - "required": false, - "since": "4.14", - "type": "string" - }, - { - "description": "whether compute offering iops is custom or not", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "customizediops", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "since": "4.4", - "type": "boolean" + "type": "list" } ], "related": "updateServiceOffering,listServiceOfferings", "response": [ { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" - }, - {}, - { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" - }, - { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { @@ -43450,53 +46198,43 @@ "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" - }, - { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" - }, - { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" - }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "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 storage type for this service offering", + "name": "storagetype", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "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.", - "name": "provisioningtype", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { @@ -43505,9 +46243,9 @@ "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": "is this a the systemvm type for system vm offering", @@ -43515,74 +46253,104 @@ "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 date this service 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": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "Root disk size in GB", + "name": "rootdisksize", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "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": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", "type": "integer" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", + "name": "isvolatile", + "type": "boolean" + }, + { + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "description": "is this a default system vm offering", + "name": "defaultuse", "type": "boolean" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", + "description": "is this a system vm offering", + "name": "issystem", "type": "boolean" }, + { + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, + {}, { "description": "the name of the service offering", "name": "name", "type": "string" }, - {}, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "the host tag for the service offering", + "name": "hosttags", + "type": "string" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", - "type": "string" + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "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" }, { @@ -43591,39 +46359,39 @@ "type": "string" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "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": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", "type": "boolean" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "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.", @@ -43631,64 +46399,60 @@ "type": "string" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" - }, - { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, + {}, { - "description": "Root disk size in GB", - "name": "rootdisksize", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" } ] }, @@ -43705,11 +46469,19 @@ "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" + }, { "description": "Template ID.", "length": 255, "name": "id", - "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": true, "type": "uuid" }, @@ -43720,134 +46492,50 @@ "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" - }, - { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", - "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" } ], - "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "the template ID", - "name": "id", + "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 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": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "the size of the template", - "name": "size", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the 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": "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": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { "description": "the date this template was created", @@ -43855,102 +46543,62 @@ "type": "date" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the status of the template", + "name": "status", "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 managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "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", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the template display text", + "name": "displaytext", "type": "string" }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "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" }, { @@ -43959,13 +46607,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -43974,8 +46622,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -43984,478 +46632,401 @@ "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": "set" }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, { "description": "the URL which the template/iso is registered from", "name": "url", "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": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the 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": "checksum of the template", - "name": "checksum", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the account name to which the template belongs", + "name": "account", "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", - "name": "childtemplates", - "type": "set" - } - ] - }, - { - "description": "lists network that are using a nicira nvp device", - "isasync": false, - "name": "listNiciraNvpDeviceNetworks", - "params": [ - { - "description": "nicira nvp device ID", - "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", - "required": true, - "type": "uuid" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "response": [ - { - "description": "zone id of the network", - "name": "zoneid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "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 zone for this template", + "name": "zonename", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "state of the network", - "name": "state", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "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": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, - {}, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the 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 value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "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": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, + {}, { - "description": "the name of the zone the network belongs to", - "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 name of the network", - "name": "name", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the first DNS for the network", - "name": "dns1", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" - }, + } + ] + }, + { + "description": "lists network that are using a nicira nvp device", + "isasync": false, + "name": "listNiciraNvpDeviceNetworks", + "params": [ { - "description": "related to what other network configuration", - "name": "related", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "nicira nvp device ID", + "length": 255, + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "required": true, + "type": "uuid" + } + ], + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "response": [ + { + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the traffic type of the network", + "name": "traffictype", "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 owner of the network", - "name": "account", - "type": "string" - }, {}, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" - }, - { - "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", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain id of the network owner", + "name": "domainid", "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": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "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": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { "description": "the list of services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, { "description": "the provider name", "name": "name", "type": "string" }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "state of the network provider", + "name": "state", + "type": "string" } ], "type": "list" @@ -44465,9 +47036,9 @@ "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", @@ -44475,35 +47046,25 @@ "type": "string" }, { - "description": "the capability name", - "name": "name", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "the second DNS for the network", - "name": "dns2", - "type": "string" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { "description": "The routing mode of network offering", @@ -44511,304 +47072,276 @@ "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the network's netmask", - "name": "netmask", - "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 type of the network", - "name": "type", + "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": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, + {}, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - } - ] - }, - { - "description": "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.", - "isasync": false, - "name": "assignVirtualMachine", - "params": [ - { - "description": "list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.", - "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", - "required": false, - "type": "list" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", - "length": 255, - "name": "networkids", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "list" + "description": "zone id of the network", + "name": "zoneid", + "type": "string" }, { - "description": "an optional project for the new VM owner.", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "account name of the new VM owner.", - "length": 255, - "name": "account", - "required": false, + "description": "the type of the network", + "name": "type", "type": "string" }, { - "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,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "domain id of the new VM owner.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "response": [ - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated with network", + "name": "tags", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project name where tag belongs to", + "name": "project", "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 type of the affinity group", - "name": "type", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the account owning the affinity group", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" } ], - "type": "set" + "type": "list" }, - {}, { - "description": "the ID of the domain in which the virtual machine exists", - "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the owner of the network", + "name": "account", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the details of the network", + "name": "details", + "type": "map" }, - {}, { - "description": "the date when this virtual machine was created", + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the date this network was created", "name": "created", "type": "date" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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 ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { @@ -44817,176 +47350,255 @@ "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + } + ] + }, + { + "description": "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.", + "isasync": false, + "name": "assignVirtualMachine", + "params": [ + { + "description": "list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.", + "length": 255, + "name": "securitygroupids", + "related": "createSecurityGroup", + "required": false, + "type": "list" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "domain id of the new VM owner.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", + "length": 255, + "name": "networkids", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "list" + }, + { + "description": "account name of the new VM owner.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "an optional project for the new VM owner.", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "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,importUnmanagedInstance", + "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,importUnmanagedInstance", + "response": [ + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + {}, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, - {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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": "the account associated with the virtual machine", + "name": "account", "type": "string" }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "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 value", + "name": "value", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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" }, + { + "description": "the account associated with the tag", + "name": "account", + "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 list of egress rules associated with the security group", + "name": "egressrule", + "response": [ { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -45000,288 +47612,514 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], "type": "set" }, { - "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": "resource type", - "name": "resourcetype", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "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": "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": "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" } ], "type": "set" }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, { "description": "the 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 domain name of the security group", "name": "domain", "type": "string" }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the 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" + } + ], + "type": "set" + }, + { + "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": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" } ], "type": "set" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "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": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, + {}, { - "description": "the ID of the virtual machine", - "name": "id", + "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 name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, { "description": "the name of the service offering of the virtual machine", "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { @@ -45289,28 +48127,23 @@ "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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 broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -45319,28 +48152,23 @@ "type": "list" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -45349,13 +48177,13 @@ "type": "boolean" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -45363,34 +48191,49 @@ "name": "ipaddress", "type": "string" }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, { "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -45399,19 +48242,14 @@ "type": "integer" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "true if nic is default, false otherwise", @@ -45419,144 +48257,165 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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" } ], "type": "set" }, - { - "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": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "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": "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": "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 password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, { "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 name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "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": "the domain associated with the tag", - "name": "domain", + "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" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" + }, + {}, + { + "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 service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the 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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" } ], "since": "3.0.0" @@ -45576,10 +48435,11 @@ } ], "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "any text associated with the success or failure", @@ -45588,11 +48448,10 @@ }, {}, { - "description": "the current status of the latest async job acting 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", @@ -45607,12 +48466,11 @@ "name": "configureNetscalerLoadBalancer", "params": [ { - "description": "Netscaler load balancer device ID", + "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": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "required": true, - "type": "uuid" + "name": "inline", + "required": false, + "type": "boolean" }, { "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", @@ -45622,26 +48480,27 @@ "type": "boolean" }, { - "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", "length": 255, - "name": "lbdevicecapacity", + "name": "podids", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "long" + "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": "capacity of the device, Capacity will be interpreted as number of networks device can handle", "length": 255, - "name": "inline", + "name": "lbdevicecapacity", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "description": "Netscaler load balancer device ID", "length": 255, - "name": "podids", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "list" + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "required": true, + "type": "uuid" } ], "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", @@ -45652,13 +48511,18 @@ "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -45667,14 +48531,14 @@ "type": "boolean" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "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": "device id of the netscaler load balancer", @@ -45682,26 +48546,16 @@ "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "device state", - "name": "lbdevicestate", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "device name", - "name": "lbdevicename", - "type": "string" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, {}, - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" - }, {}, { "description": "true if device is dedicated for an account", @@ -45709,29 +48563,34 @@ "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": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "device state", + "name": "lbdevicestate", "type": "string" + }, + { + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" } ] }, @@ -45740,6 +48599,20 @@ "isasync": false, "name": "listOvsElements", "params": [ + { + "description": "list network offerings by enabled state", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "list ovs elements by network service provider id", "length": 255, @@ -45762,13 +48635,6 @@ "required": false, "type": "integer" }, - { - "description": "list network offerings by enabled state", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" - }, { "description": "list ovs elements by id", "length": 255, @@ -45776,30 +48642,30 @@ "related": "listOvsElements,configureOvsElement", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "configureOvsElement", "response": [ { - "description": "the project name of the address", - "name": "project", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, + {}, + {}, { - "description": "the 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 domain associated with the provider", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -45807,38 +48673,77 @@ "name": "account", "type": "string" }, - {}, { "description": "the physical network service provider id of the provider", "name": "nspid", "type": "string" }, { - "description": "the id of the ovs", - "name": "id", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the id of the ovs", + "name": "id", "type": "string" }, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + } + ] + }, + { + "description": "delete Tungsten-Fabric service group", + "isasync": true, + "name": "deleteTungstenFabricServiceGroup", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric service group", + "length": 255, + "name": "servicegroupuuid", + "required": true, + "type": "string" + } + ], + "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", + "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" + } ] }, { @@ -45847,10 +48752,10 @@ "name": "associateUcsProfileToBlade", "params": [ { - "description": "blade id", + "description": "ucs manager id", "length": 255, - "name": "bladeid", - "related": "associateUcsProfileToBlade", + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", "required": true, "type": "uuid" }, @@ -45862,10 +48767,10 @@ "type": "string" }, { - "description": "ucs manager id", + "description": "blade id", "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", + "name": "bladeid", + "related": "associateUcsProfileToBlade", "required": true, "type": "uuid" } @@ -45873,16 +48778,27 @@ "related": "", "response": [ { - "description": "cloudstack host id this blade associates to", - "name": "hostid", + "description": "ucs manager id", + "name": "ucsmanagerid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "cloudstack host id this blade associates to", + "name": "hostid", + "type": "string" + }, + {}, { "description": "ucs blade dn", "name": "bladedn", @@ -45893,21 +48809,10 @@ "name": "id", "type": "string" }, - {}, - { - "description": "ucs manager id", - "name": "ucsmanagerid", - "type": "string" - }, { "description": "associated ucs profile dn", "name": "profiledn", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -45917,44 +48822,44 @@ "name": "deleteUserFromProject", "params": [ { - "description": "Id of the user to be removed from the project", + "description": "ID of the project to remove the user from", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": true, "type": "uuid" }, { - "description": "ID of the project to remove the user from", + "description": "Id of the user to be removed from the project", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "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", + "description": "the UUID of the latest async job acting on 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" } ], "since": "4.15.0" @@ -45965,23 +48870,31 @@ "name": "updateVmwareDc", "params": [ { - "description": "The username required to connect to resource.", + "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": "username", + "name": "vcenter", "required": false, "type": "string" }, { - "description": "VMware datacenter name.", + "description": "The zone ID", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", + "length": 255, + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "VMware datacenter name.", "length": 255, - "name": "vcenter", + "name": "name", "required": false, "type": "string" }, @@ -45993,32 +48906,24 @@ "type": "string" }, { - "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", + "description": "The username required to connect to resource.", "length": 255, - "name": "isrecursive", + "name": "username", "required": false, - "type": "boolean" - }, - { - "description": "The zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "type": "string" } ], "related": "addVmwareDc,listVmwareDcs", "response": [ { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "The VMware Datacenter name", + "name": "name", "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", @@ -46026,24 +48931,63 @@ "type": "integer" }, { - "description": "The VMware Datacenter name", - "name": "name", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "type": "string" }, + {}, + {}, + { + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, + } + ], + "since": "4.12.0" + }, + { + "description": "Checks the 2FA code for the user.", + "isasync": false, + "name": "validateUserTwoFactorAuthenticationCode", + "params": [ + { + "description": "two factor authentication code", + "length": 255, + "name": "codefor2fa", + "required": true, + "type": "string" + } + ], + "response": [ {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "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.12.0" + "since": "4.18.0" }, { "description": "Starts a router.", @@ -46068,16 +49012,15 @@ ], "related": "", "response": [ - {}, { "description": "the id of the router", "name": "healthchecks", "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the id of the router", @@ -46085,10 +49028,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" }, + {}, {} ], "since": "4.14.0" @@ -46099,33 +49043,32 @@ "name": "listNetscalerControlCenter", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "uuid", - "name": "uuid", + "description": "ncc_ip", + "name": "ipaddress", "type": "string" }, { @@ -46133,20 +49076,15 @@ "name": "username", "type": "string" }, - {}, - { - "description": "num_retries", - "name": "numretries", - "type": "string" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id", + "name": "id", "type": "string" }, + {}, { - "description": "id", - "name": "id", + "description": "num_retries", + "name": "numretries", "type": "string" }, { @@ -46154,9 +49092,15 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "ncc_ip", - "name": "ipaddress", + "description": "uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -46166,6 +49110,13 @@ "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, @@ -46181,9 +49132,9 @@ "type": "long" }, { - "description": "New maximum number of IOPS", + "description": "New minimum number of IOPS", "length": 255, - "name": "maxiops", + "name": "miniops", "required": false, "type": "long" }, @@ -46202,47 +49153,104 @@ "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": true, "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", + "type": "string" }, { - "description": "New minimum number of IOPS", - "length": 255, - "name": "miniops", - "required": false, + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" - } - ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - {}, + }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "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 snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -46250,59 +49258,64 @@ "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, - {}, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the 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", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "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 project id of the vpn", - "name": "projectid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { @@ -46311,18 +49324,23 @@ "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { @@ -46331,107 +49349,153 @@ "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { "description": "name of the disk volume", "name": "name", "type": "string" }, + {}, { - "description": "max iops of the disk volume", - "name": "maxiops", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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 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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the 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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -46443,164 +49507,49 @@ "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "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", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "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": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, { "description": "IO requests read rate of the disk volume per the disk offering", "name": "diskIopsReadRate", "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the path of the volume", - "name": "path", - "type": "string" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "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 name of the template for the virtual machine", - "name": "templatename", + "description": "ID of the disk volume", + "name": "id", "type": "string" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" } ] }, @@ -46618,19 +49567,19 @@ "type": "uuid" }, { - "description": "the domain ID of account owning the affinity group", + "description": "the account of the affinity group. Must be specified with domain ID", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the account of the affinity group. Must be specified with domain ID", + "description": "The ID of the affinity group. Mutually exclusive with name parameter", "length": 255, - "name": "account", + "name": "id", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "The name of the affinity group. Mutually exclusive with ID parameter", @@ -46640,24 +49589,29 @@ "type": "string" }, { - "description": "The ID of the affinity group. Mutually exclusive with name parameter", + "description": "the domain ID of account owning the affinity group", "length": 255, - "name": "id", - "related": "", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, {}, @@ -46665,11 +49619,6 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, @@ -46688,27 +49637,27 @@ } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "3.0.0" @@ -46728,28 +49677,28 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "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": "3.0.0" }, @@ -46759,23 +49708,23 @@ "name": "listNetworkDevice", "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" }, @@ -46796,6 +49745,12 @@ ], "related": "addNetworkDevice", "response": [ + { + "description": "the ID of the network device", + "name": "id", + "type": "string" + }, + {}, {}, { "description": "the current status of the latest async job acting on this object", @@ -46806,13 +49761,7 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the ID of the network device", - "name": "id", - "type": "string" - }, - {} + } ] }, { @@ -46821,26 +49770,19 @@ "name": "updateStorageNetworkIpRange", "params": [ { - "description": "the ending IP address", + "description": "Optional. the vlan the ip range sits on", "length": 255, - "name": "endip", + "name": "vlan", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the beginning IP address", + "description": "the ending IP address", "length": 255, - "name": "startip", + "name": "endip", "required": false, "type": "string" }, - { - "description": "Optional. the vlan the ip range sits on", - "length": 255, - "name": "vlan", - "required": false, - "type": "integer" - }, { "description": "UUID of storage network ip range", "length": 255, @@ -46855,18 +49797,25 @@ "name": "netmask", "required": false, "type": "string" + }, + { + "description": "the beginning IP address", + "length": 255, + "name": "startip", + "required": false, + "type": "string" } ], "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the end ip of the storage network IP range", + "name": "endip", + "type": "string" }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" }, { @@ -46874,47 +49823,47 @@ "name": "podid", "type": "string" }, + {}, { - "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 netmask of the storage network IP range", - "name": "netmask", + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, - {}, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, + {}, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "3.0.0" @@ -46925,18 +49874,18 @@ "name": "dedicatePod", "params": [ { - "description": "the ID of the containing domain", + "description": "the ID of the Pod", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": true, "type": "uuid" }, { - "description": "the ID of the Pod", + "description": "the ID of the containing domain", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": true, "type": "uuid" }, @@ -46950,20 +49899,21 @@ ], "related": "listDedicatedPods", "response": [ + {}, + {}, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "description": "the ID of the Pod", + "name": "podid", "type": "string" }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", + "description": "the Name of the Pod", + "name": "podname", "type": "string" }, - {}, { - "description": "the Name of the Pod", - "name": "podname", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" }, { @@ -46971,25 +49921,24 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the ID of the Pod", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "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" } ] @@ -47000,11 +49949,12 @@ "name": "listProjectRoles", "params": [ { - "description": "List project role by project role name.", + "description": "List project role by project role ID.", "length": 255, - "name": "name", + "name": "projectroleid", + "related": "createProjectRole,listProjectRoles,updateProjectRole", "required": false, - "type": "string" + "type": "uuid" }, { "description": "List by keyword", @@ -47014,41 +49964,40 @@ "type": "string" }, { - "description": "List project role by project role ID.", + "description": "", "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List project role by project ID.", + "description": "List project role by project role name.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "List project role by project ID.", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" } ], "related": "createProjectRole,updateProjectRole", "response": [ { - "description": "the ID of the role", - "name": "id", + "description": "the name of the role", + "name": "name", "type": "string" }, { @@ -47056,28 +50005,28 @@ "name": "description", "type": "string" }, - {}, - {}, - { - "description": "the id of the project", - "name": "projectid", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the name of the role", - "name": "name", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "the ID of the role", + "name": "id", + "type": "string" + }, + { + "description": "the id of the project", + "name": "projectid", + "type": "string" + }, + {} ], "since": "4.15.0" }, @@ -47097,32 +50046,32 @@ ], "related": "addOpenDaylightController", "response": [ - {}, - {}, { - "description": "device id of the controller", - "name": "id", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "device id of the controller", + "name": "id", "type": "string" }, + {}, { - "description": "the name assigned to the controller", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on 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", @@ -47130,8 +50079,8 @@ "type": "string" }, { - "description": "the url of the controller api", - "name": "url", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" } ] @@ -47142,39 +50091,40 @@ "name": "updateTemplate", "params": [ { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", "required": false, - "type": "map" + "type": "string" }, { - "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 type of the template", + "description": "the ID of the image file", "length": 255, - "name": "templatetype", - "required": false, - "type": "string" + "name": "id", + "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "cleanupdetails", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "the name of the image file", "length": 255, - "name": "requireshvm", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the format for the image", @@ -47184,25 +50134,26 @@ "type": "string" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "the type of the template", "length": 255, - "name": "isdynamicallyscalable", + "name": "templatetype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "description": "the ID of the OS type that best represents the OS of this image.", + "length": 255, + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the image file", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "name", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { "description": "sort key of the template, integer", @@ -47212,231 +50163,244 @@ "type": "integer" }, { - "description": "the ID of the image file", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "id", - "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "name": "bootable", + "required": false, + "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "sshkeyenabled", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "isdynamicallyscalable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if the image supports the password reset feature; default is false", + "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": "passwordenabled", + "name": "cleanupdetails", "required": false, "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "isrouting", + "name": "passwordenabled", "required": false, "type": "boolean" } ], - "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "the template name", - "name": "name", + "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 ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "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 requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, + {}, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "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": "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" } ], "type": "set" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "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": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, - {}, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the status of the template", - "name": "status", + "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": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the template ID", + "name": "id", "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 id of the template", + "name": "projectid", "type": "string" }, { - "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": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -47444,45 +50408,40 @@ "name": "sourcetemplateid", "type": "string" }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, { "description": "Lists the download progress of a template across all secondary storages", "name": "downloaddetails", "type": "list" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "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 format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { "description": "the tag of this template", @@ -47490,70 +50449,80 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "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": "the ID of the zone for this template", - "name": "zoneid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "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 physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" } ] }, @@ -47562,29 +50531,6 @@ "isasync": false, "name": "createVlanIpRange", "params": [ - { - "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged", - "length": 255, - "name": "vlan", - "required": false, - "type": "string" - }, - { - "description": "the network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "domain ID of the account owning a VLAN", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, { "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, @@ -47600,42 +50546,44 @@ "type": "string" }, { - "description": "the netmask of the VLAN IP range", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "netmask", + "name": "forsystemvms", "required": false, - "type": "string" + "type": "boolean" }, { - "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 gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "ip6gateway", + "name": "netmask", "required": false, "type": "string" }, { - "description": "the ending IP address in the VLAN IP range", + "description": "the physical network id", "length": 255, - "name": "endip", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the gateway of the VLAN IP range", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "gateway", + "name": "endipv6", "required": false, "type": "string" }, { - "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited", + "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, "name": "account", "required": false, @@ -47650,16 +50598,31 @@ "type": "uuid" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", "length": 255, - "name": "endipv6", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "the ending IP address in the VLAN IP range", + "length": 255, + "name": "endip", "required": false, "type": "string" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", "length": 255, - "name": "startip", + "name": "ip6gateway", + "required": false, + "type": "string" + }, + { + "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged", + "length": 255, + "name": "vlan", "required": false, "type": "string" }, @@ -47671,76 +50634,92 @@ "type": "boolean" }, { - "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited", + "description": "the beginning IP address in the VLAN IP range", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "startip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the physical network id", + "description": "the network id", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" + }, + { + "description": "the gateway of the VLAN IP range", + "length": 255, + "name": "gateway", + "required": false, + "type": "string" } ], "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "response": [ + {}, { "description": "the cidr of the VLAN IP range", "name": "cidr", "type": "string" }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, { "description": "the virtual network for the VLAN IP range", "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, - {}, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "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", + "type": "string" + }, + { + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -47749,18 +50728,18 @@ "type": "integer" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { @@ -47768,24 +50747,19 @@ "name": "podname", "type": "string" }, - { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" - }, { "description": "the domain name of the VLAN IP range", "name": "domain", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { @@ -47793,40 +50767,35 @@ "name": "endip", "type": "string" }, + {}, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", - "type": "string" - }, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, - {}, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" } ] @@ -47837,12 +50806,12 @@ "name": "updateVpnConnection", "params": [ { - "description": "id of vpn connection", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", - "required": true, - "type": "uuid" + "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", @@ -47853,102 +50822,107 @@ "type": "string" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "id of vpn connection", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "id", + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "required": true, + "type": "uuid" } ], "related": "createVpnConnection,listVpnConnections", "response": [ { - "description": "the connection ID", - "name": "id", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, - {}, - {}, { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "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 customer gateway ID", - "name": "s2scustomergatewayid", + "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": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "the project name", + "name": "project", + "type": "string" + }, { "description": "State of vpn connection", "name": "passive", "type": "boolean" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "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": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, + {}, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { "description": "if DPD is enabled for customer gateway", @@ -47956,48 +50930,43 @@ "type": "boolean" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project name", - "name": "project", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the project id", + "name": "projectid", "type": "string" } ], @@ -48009,11 +50978,11 @@ "name": "listPaloAltoFirewallNetworks", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "palo alto balancer device ID", @@ -48031,65 +51000,150 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" + }, + {}, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "the owner of the network", + "name": "account", + "type": "string" + }, + { + "description": "state of the network", + "name": "state", + "type": "string" + }, + { + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the network's gateway", - "name": "gateway", - "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 domain", - "name": "networkdomain", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the type of the network", - "name": "type", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, - {}, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { "description": "true if network is system, false otherwise", @@ -48097,79 +51151,83 @@ "type": "boolean" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "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 total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "acl type - access type to the network", + "name": "acltype", + "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": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" }, - {}, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { @@ -48177,8 +51235,8 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -48187,23 +51245,23 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -48212,65 +51270,70 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "the first DNS for the network", - "name": "dns1", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the name of the network", - "name": "name", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the name of the network", + "name": "name", + "type": "string" }, { "description": "the list of services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "uuid of the network provider", - "name": "id", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the provider name", + "name": "name", + "type": "string" }, { "description": "the destination physical network", @@ -48278,23 +51341,23 @@ "type": "string" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" } ], @@ -48309,46 +51372,31 @@ "name": "name", "type": "string" }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, { "description": "the capability value", "name": "value", "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" - }, { "description": "The external id of the network", "name": "externalid", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -48356,154 +51404,144 @@ "type": "string" }, { - "description": "state of the network", - "name": "state", - "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": "list networks that are persistent", - "name": "ispersistent", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "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" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "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", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, + {}, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the project id of the ipaddress", "name": "projectid", "type": "string" }, - { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" - }, { "description": "the displaytext of the network", "name": "displaytext", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "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 second IPv4 DNS for the network", + "name": "dns2", "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 private gateway", + "name": "associatednetworkid", "type": "string" - }, + } + ] + }, + { + "description": "Synchronize Tungsten-Fabric data", + "isasync": false, + "name": "synchronizeTungstenFabricData", + "params": [ { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, + "description": "provider id", + "length": 255, + "name": "id", + "related": "listTungstenFabricProviders", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -48527,31 +51565,166 @@ "name": "jobid", "type": "string" }, + {}, + {}, + { + "description": "The path field for the volume", + "name": "path", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists management servers.", + "isasync": false, + "name": "listManagementServers", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the id of the management server", + "length": 255, + "name": "id", + "related": "listManagementServers", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the management server", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "the java distribution name running the management server process", + "name": "javadistribution", + "type": "string" + }, + { + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "type": "string" + }, + { + "description": "the name of the management server", + "name": "name", + "type": "string" + }, + { + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" + }, + { + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", + "type": "string" + }, + { + "description": "the version of the management server", + "name": "version", + "type": "string" + }, + {}, + { + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "The path field for the volume", - "name": "path", + "description": "the version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" + }, + { + "description": "the ID of the management server", + "name": "id", "type": "string" }, {}, - {} + { + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" + } ] }, { - "description": "Lists management servers.", + "description": "list Tungsten-Fabric policy", "isasync": false, - "name": "listManagementServers", + "name": "listTungstenFabricPolicyRule", "params": [ { - "description": "the name of the management server", + "description": "the uuid of Tungsten-Fabric rule", + "length": 255, + "name": "ruleuuid", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "List by keyword", @@ -48566,54 +51739,66 @@ "name": "page", "required": false, "type": "integer" + } + ], + "related": "addTungstenFabricPolicyRule", + "response": [ + { + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", + "type": "string" }, { - "description": "the id of the management server", - "length": 255, - "name": "id", - "related": "listManagementServers", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", + "type": "int" + }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", "type": "string" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "Tungsten-Fabric policy action", + "name": "action", + "type": "string" }, + {}, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", "type": "string" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", "type": "string" }, { - "description": "the ID of the management server", - "name": "id", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", "type": "string" }, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" }, { "description": "the UUID of the latest async job acting on this object", @@ -48621,75 +51806,114 @@ "type": "string" }, { - "description": "the name of the management server", - "name": "name", - "type": "string" + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", + "type": "int" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, - {}, { - "description": "the version of the management server", - "name": "version", + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", "type": "string" }, { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "type": "date" + "description": "Tungsten-Fabric policy name", + "name": "direction", + "type": "string" }, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, - {} + { + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", + "type": "string" + } ] }, { - "description": "Updates a vm group", - "isasync": false, - "name": "updateInstanceGroup", + "description": "delete Tungsten-Fabric policy", + "isasync": true, + "name": "deleteTungstenFabricPolicy", "params": [ { - "description": "Instance group ID", + "description": "the ID of zone", "length": 255, - "name": "id", - "related": "createInstanceGroup,updateInstanceGroup", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "new instance group name", + "description": "the Uuid of Tungsten-Fabric tag type", "length": 255, - "name": "name", - "required": false, + "name": "policyuuid", + "required": true, "type": "string" } ], - "related": "createInstanceGroup", "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 the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Updates a vm group", + "isasync": false, + "name": "updateInstanceGroup", + "params": [ + { + "description": "new instance group name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "Instance group ID", + "length": 255, + "name": "id", + "related": "createInstanceGroup,updateInstanceGroup", + "required": true, + "type": "uuid" + } + ], + "related": "createInstanceGroup", + "response": [ + { + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, { @@ -48698,23 +51922,25 @@ "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID of the instance group", + "name": "domainid", + "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", + "description": "the name of the instance group", + "name": "name", "type": "string" }, + {}, { - "description": "the project ID of the instance group", - "name": "projectid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -48722,13 +51948,21 @@ "name": "id", "type": "string" }, - {}, { - "description": "the name of the instance group", - "name": "name", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, - {}, + { + "description": "the 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": "the domain name of the instance group", "name": "domain", @@ -48741,20 +51975,6 @@ "isasync": true, "name": "changeOfferingForVolume", "params": [ - { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "type": "long" - }, - { - "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", - "length": 255, - "name": "automigrate", - "required": false, - "type": "boolean" - }, { "description": "new disk offering id", "length": 255, @@ -48771,17 +51991,23 @@ "type": "boolean" }, { - "description": "the ID of the volume", + "description": "New volume size in GB for the custom disk offering", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "name": "size", + "required": false, + "type": "long" }, { - "description": "New volume size in GB 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": "size", + "name": "automigrate", + "required": false, + "type": "boolean" + }, + { + "description": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", "required": false, "type": "long" }, @@ -48791,44 +52017,67 @@ "name": "maxiops", "required": false, "type": "long" + }, + { + "description": "the ID of the volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, + "type": "uuid" } ], "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { "description": "need quiesce vm or not when taking snapshot", @@ -48836,8 +52085,8 @@ "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { @@ -48846,8 +52095,14 @@ "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + {}, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -48855,115 +52110,130 @@ "name": "hasannotations", "type": "boolean" }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, { "description": "provisioning type used to create volumes.", "name": "provisioningtype", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "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", + "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", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "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": "cluster id of the volume", - "name": "clusterid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "name of the disk offering", + "name": "diskofferingname", "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 display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "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": "ID of the disk offering", - "name": "diskofferingid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "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", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "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 service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", @@ -48971,43 +52241,43 @@ "type": "string" }, { - "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 ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "pod name of the volume", + "name": "podname", "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 primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -49020,178 +52290,276 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "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 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": "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" } ], "type": "set" }, { - "description": "the status of the volume", - "name": "status", + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "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" + }, + { + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, {}, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, { "description": "the read (IO) of disk on the vm", "name": "diskioread", "type": "long" + } + ], + "since": "4.17" + }, + { + "description": "List the uploaded certificates for direct download templates", + "isasync": false, + "name": "listTemplateDirectDownloadCertificates", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "list direct download certificate by ID", + "length": 255, + "name": "id", + "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", + "required": false, + "type": "uuid" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the zone where certificates are uploaded", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "if set to true: include the hosts where the certificate is uploaded to", + "length": 255, + "name": "listhosts", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "uploadTemplateDirectDownloadCertificate", + "response": [ + { + "description": "the direct download certificate alias", + "name": "alias", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the direct download certificate issuer", + "name": "issuer", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" }, + {}, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the direct download certificate issuer", + "name": "validity", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the current status of the latest async job acting 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 date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the direct download certificate version", + "name": "version", + "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", + "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the zone name where the certificate is uploaded", + "name": "zonename", + "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the direct download certificate id", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", + "type": "string" + }, + { + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" } ], - "since": "4.17" + "since": "4.17.0" }, { - "description": "List the uploaded certificates for direct download templates", + "description": "List ucs manager", "isasync": false, - "name": "listTemplateDirectDownloadCertificates", + "name": "listUcsManagers", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -49200,18 +52568,18 @@ "type": "integer" }, { - "description": "the zone where certificates are uploaded", + "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": "list direct download certificate by ID", + "description": "the zone id", "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, @@ -49221,27 +52589,106 @@ "name": "keyword", "required": false, "type": "string" + } + ], + "related": "addUcsManager", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the ID of the ucs manager", + "name": "id", + "type": "string" }, { - "description": "", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the name of ucs manager", + "name": "name", + "type": "string" + }, + { + "description": "the url of ucs manager", + "name": "url", + "type": "string" + }, + { + "description": "the zone ID of ucs manager", + "name": "zoneid", + "type": "string" + } + ] + }, + { + "description": "Upgrades domain router to a new service offering", + "isasync": false, + "name": "changeServiceForRouter", + "params": [ + { + "description": "the service offering ID to apply to the domain router", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "if set to true: include the hosts where the certificate is uploaded to", + "description": "The ID of the router", "length": 255, - "name": "listhosts", - "required": false, - "type": "boolean" + "name": "id", + "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" } ], - "related": "uploadTemplateDirectDownloadCertificate", + "related": "destroyRouter,listRouters,listInternalLoadBalancerVMs", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { @@ -49250,242 +52697,372 @@ "type": "integer" }, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the direct download certificate id", + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + {}, + { + "description": "the id of the router", "name": "id", "type": "string" }, { - "description": "the zone name where the certificate is uploaded", + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the Zone name for the router", "name": "zonename", "type": "string" }, { - "description": "the direct download certificate subject", - "name": "subject", + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the direct download certificate serial num", - "name": "serialnum", + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + } + ], + "type": "set" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "issuer", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the direct download certificate version", - "name": "version", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, - {}, - {}, { - "description": "the direct download certificate alias", - "name": "alias", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "validity", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" - } - ], - "since": "4.17.0" - }, - { - "description": "List ucs manager", - "isasync": false, - "name": "listUcsManagers", - "params": [ - { - "description": "the ID of the ucs manager", - "length": 255, - "name": "id", - "related": "listUcsManagers,addUcsManager", - "required": false, - "type": "uuid" }, { - "description": "the zone id", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the name of the router", + "name": "name", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" - } - ], - "related": "addUcsManager", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the ucs manager", - "name": "id", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the url of ucs manager", - "name": "url", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, - {}, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "description": "the version of template", + "name": "version", "type": "string" }, - {}, { - "description": "the name of ucs manager", - "name": "name", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" - } - ] - }, - { - "description": "Upgrades domain router to a new service offering", - "isasync": false, - "name": "changeServiceForRouter", - "params": [ - { - "description": "The ID of the router", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" }, { - "description": "the service offering ID to apply to the domain router", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,listInternalLoadBalancerVMs", - "response": [ - { - "description": "the hostname for the router", - "name": "hostname", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, - {}, { "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 corresponding guest network", - "name": "guestnetworkname", - "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 control state of the host for the router", + "name": "hostcontrolstate", "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 second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { @@ -49497,11 +53074,6 @@ "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", @@ -49512,6 +53084,11 @@ "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", @@ -49521,2068 +53098,2141 @@ "type": "list" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" + } + ] + }, + { + "description": "Remove an Ldap Configuration", + "isasync": false, + "name": "deleteLdapConfiguration", + "params": [ + { + "description": "linked domain", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "port", + "length": 255, + "name": "port", + "required": false, + "type": "integer" + } + ], + "related": "addLdapConfiguration", + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "linked domain", + "name": "domainid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "port teh ldap server is running on", + "name": "port", + "type": "int" + } + ], + "since": "4.2.0" + }, + { + "description": "Updates the volume.", + "isasync": true, + "name": "updateVolume", + "params": [ + { + "description": "The chain info of the volume", + "length": 255, + "name": "chaininfo", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "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 first DNS for the router", - "name": "dns1", + "description": "The path of the volume", + "length": 255, + "name": "path", + "required": false, "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "The state of the volume", + "length": 255, + "name": "state", + "required": false, + "since": "4.3", + "type": "string" + }, + { + "description": "Destination storage pool UUID for the volume", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "since": "4.3", + "type": "uuid" + }, + { + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": false, + "type": "uuid" + }, + { + "description": "an optional field, whether to the display the volume to the end user or not.", + "length": 255, + "name": "displayvolume", + "required": false, "type": "boolean" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "new name of the volume", + "length": 255, + "name": "name", + "required": false, + "since": "4.16", "type": "string" + } + ], + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "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": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "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": "macaddress", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "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 traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "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 state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "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", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "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": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, {}, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + {}, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the name of the router", + "description": "name of the disk volume", "name": "name", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" - } - ] - }, - { - "description": "Remove an Ldap Configuration", - "isasync": false, - "name": "deleteLdapConfiguration", - "params": [ + }, { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": true, + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "port", - "length": 255, - "name": "port", - "required": false, - "type": "integer" - } - ], - "related": "addLdapConfiguration", - "response": [ + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, { - "description": "name of the host running the ldap server", - "name": "hostname", + "description": "the status of the volume", + "name": "status", "type": "string" }, - {}, { - "description": "linked domain", - "name": "domainid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, - {}, { - "description": "port teh ldap server is running on", - "name": "port", - "type": "int" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Updates the volume.", - "isasync": true, - "name": "updateVolume", - "params": [ + }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "type": "uuid" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "The chain info of the volume", - "length": 255, - "name": "chaininfo", - "required": false, - "since": "4.4", + "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": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "The path of the volume", - "length": 255, - "name": "path", - "required": false, + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "Destination storage pool UUID for the volume", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "since": "4.3", - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "new name of the volume", - "length": 255, - "name": "name", - "required": false, - "since": "4.16", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + } + ] + }, + { + "description": "Lists traffic types of a given physical network.", + "isasync": false, + "name": "listTrafficTypes", + "params": [ + { + "description": "List by keyword", "length": 255, - "name": "customid", + "name": "keyword", "required": false, - "since": "4.4", "type": "string" }, { - "description": "an optional field, whether to the display the volume to the end user or not.", + "description": "the Physical Network ID", "length": 255, - "name": "displayvolume", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "The state of the volume", + "description": "", "length": 255, - "name": "state", + "name": "page", "required": false, - "since": "4.3", - "type": "string" + "type": "integer" } ], - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "listNetworkServiceProviders", "response": [ { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, - {}, { - "description": "the disk utilization", - "name": "utilization", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "name of the virtual machine", - "name": "vmname", + "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": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the provider name", + "name": "name", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Creates a Project role", + "isasync": false, + "name": "createProjectRole", + "params": [ + { + "description": "ID of project where role is being created", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "creates a project role with this unique name", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "The description of the Project role", + "length": 255, + "name": "description", + "required": false, + "type": "string" + } + ], + "related": "updateProjectRole", + "response": [ + { + "description": "the id of the project", + "name": "projectid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the description of the role", + "name": "description", "type": "string" }, + {}, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the ID of the role", + "name": "id", "type": "string" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.15.0" + }, + { + "description": "Updates account information for the authenticated user", + "isasync": false, + "name": "updateAccount", + "params": [ + { + "description": "Current account name", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "Network domain for the account's networks; empty string will update domainName with NULL value", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" + }, + { + "description": "New name for the account", + "length": 255, + "name": "newname", + "required": false, "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "Details for the account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" + }, + { + "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": "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" + } + ], + "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", + "response": [ + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, + {}, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "name of the disk volume", - "name": "name", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "the domain associated with the tag", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the 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", + "type": "string" + }, + { + "description": "the domain name of the user", "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the account associated with the tag", + "description": "the account name of the user", "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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 user state", + "name": "state", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" } ], - "type": "set" + "type": "list" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, + {}, { - "description": "the status of the volume", - "name": "status", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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 bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the name of the account", + "name": "name", + "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, - {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" - } - ] - }, - { - "description": "Lists traffic types of a given physical network.", - "isasync": false, - "name": "listTrafficTypes", - "params": [ - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "listNetworkServiceProviders", - "response": [ - {}, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "state of the network provider", + "description": "the state of the account", "name": "state", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the provider name", - "name": "name", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "uuid of the network provider", - "name": "id", - "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", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "type": "integer" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, - {}, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Creates a Project role", + "description": "Adds secondary storage.", "isasync": false, - "name": "createProjectRole", + "name": "addSecondaryStorage", "params": [ { - "description": "ID of project where role is being created", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, - { - "description": "creates a project role with this unique name", + "description": "the URL for the secondary storage", "length": 255, - "name": "name", + "name": "url", "required": true, "type": "string" }, { - "description": "The description of the Project role", + "description": "the Zone ID for the secondary storage", "length": 255, - "name": "description", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "updateProjectRole", + "related": "listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "the id of the project", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + {}, + {}, + { + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "the 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 ID of the image store", + "name": "id", "type": "string" }, { - "description": "the description of the role", - "name": "description", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the role", + "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 ID of the role", - "name": "id", - "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", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, - {}, - {} - ], - "since": "4.15.0" + { + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + } + ] }, { - "description": "Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC)", - "isasync": true, - "name": "createIpv6FirewallRule", + "description": "Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.", + "isasync": false, + "name": "updateVirtualMachine", "params": [ { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", - "length": 255, - "name": "protocol", - "required": true, + "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 network of the VM the Ipv6 firewall rule will be created for", + "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "details", + "required": false, + "type": "map" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "true if high-availability is enabled for the virtual machine, false otherwise", "length": 255, - "name": "startport", + "name": "haenable", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "type of the ICMP message being sent", + "description": "group of the virtual machine", "length": 255, - "name": "icmptype", + "name": "group", "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": "the ID of the userdata", "length": 255, - "name": "cidrlist", + "name": "userdataid", + "related": "", "required": false, - "type": "list" + "since": "4.18", + "type": "uuid" }, { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "user generated name", "length": 255, - "name": "destcidrlist", + "name": "displayname", "required": false, - "type": "list" + "type": "string" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "traffictype", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "the ending port of Ipv6 firewall rule", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "endport", + "name": "userdatadetails", "required": false, - "type": "integer" + "since": "4.18", + "type": "map" }, { - "description": "error code for this ICMP message", + "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": "icmpcode", + "name": "securitygroupnames", + "related": "createSecurityGroup", "required": false, - "type": "integer" + "type": "list" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "The ID of the virtual machine", "length": 255, - "name": "fordisplay", - "required": false, - "type": "boolean" - } - ], - "related": "updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", - "response": [ - {}, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" + "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,importUnmanagedInstance", + "required": true, + "type": "uuid" }, { - "description": "the state of the rule", - "name": "state", + "description": "instance name of the user vm", + "length": 255, + "name": "instancename", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "length": 255, + "name": "dhcpoptionsnetworklist", + "required": false, + "type": "map" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "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 VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" + "description": "the ID of the OS type that best represents this VM.", + "length": 255, + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", + "required": false, + "type": "uuid" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" + "description": "list of security group ids to be applied on the virtual machine.", + "length": 255, + "name": "securitygroupids", + "related": "createSecurityGroup", + "required": false, + "type": "list" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" + "description": "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", + "required": false, + "type": "boolean" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", + "required": false, + "since": "4.12", "type": "string" - }, - {}, + } + ], + "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,importUnmanagedInstance", + "response": [ { - "description": "is firewall for display to the regular user", - "name": "fordisplay", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" + "description": "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", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "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": "tag value", - "name": "value", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the project id the tag belongs to", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain name of the security group", + "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": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" } ], - "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": "Network domain for the account's networks; empty string will update domainName with NULL value", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" + "type": "set" }, { - "description": "New name for the account", - "length": 255, - "name": "newname", - "required": false, - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "Current account name", - "length": 255, - "name": "account", - "required": false, + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "Details for the account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" - }, - { - "description": "The UUID of the domain where the account exists", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "Account UUID", - "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - } - ], - "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", - "response": [ - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, - {}, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "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 public ip addresses this account can acquire", - "name": "iplimit", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, + {}, { - "description": "the list of users associated with account", - "name": "user", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the user ID", - "name": "id", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "id of the resource", + "name": "resourceid", "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" - }, - { - "description": "the account name of the user", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the user", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } - ], - "type": "list" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total number of 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 number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" - }, - { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, - {}, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the state of the account", - "name": "state", - "type": "string" - }, - { - "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": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "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 number of projects the account can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the name of the account", - "name": "name", - "type": "string" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" - } - ] - }, - { - "description": "Adds secondary storage.", - "isasync": false, - "name": "addSecondaryStorage", - "params": [ + ], + "type": "set" + }, { - "description": "the URL for the secondary storage", - "length": 255, - "name": "url", - "required": true, + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the Zone ID for the secondary storage", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "response": [ - {}, - { - "description": "defines if store is read-only", - "name": "readonly", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "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 name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the url of the image store", - "name": "url", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" - } - ] - }, - { - "description": "Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.", - "isasync": false, - "name": "updateVirtualMachine", - "params": [ - { - "description": "an optional field, whether to the display the vm to the end user or not.", - "length": 255, - "name": "displayvm", - "required": false, - "type": "boolean" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", - "length": 255, - "name": "dhcpoptionsnetworklist", - "required": false, - "type": "map" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", - "required": false, - "since": "4.12", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "an optional 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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", - "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup", - "required": false, - "type": "list" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "list of security group ids to be applied on the virtual machine.", - "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", - "required": false, - "type": "list" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "user generated name", - "length": 255, - "name": "displayname", - "required": false, + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "group of the virtual machine", - "length": 255, - "name": "group", - "required": false, + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", - "length": 255, - "name": "cleanupdetails", - "required": false, + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "instance name of the user vm", - "length": 255, - "name": "instancename", - "required": false, - "since": "4.4", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if high-availability is enabled for the virtual machine, false otherwise", - "length": 255, - "name": "haenable", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the OS type that best represents this VM.", - "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "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", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "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,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - } - ], - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "response": [ - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "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 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": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { @@ -51591,2402 +55241,2401 @@ "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "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 name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" }, - {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "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", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, + {}, { - "description": "the account associated with the virtual machine", - "name": "account", - "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the 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 gateway of IPv6 network", + "name": "ip6gateway", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the project name of the vm", + "name": "project", "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": "customer associated with the tag", - "name": "customer", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" } ], "type": "set" }, - {}, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "State of the Service from LB rule", + "name": "servicestate", "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "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 memory allocated for the virtual machine", - "name": "memory", + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, "type": "integer" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "destcidrlist", + "required": false, + "type": "list" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the starting port of Ipv6 firewall rule", + "length": 255, + "name": "startport", + "required": false, "type": "integer" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the ending port of Ipv6 firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "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 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": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "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": "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": "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "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" - } - ], - "type": "set" + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "type": "boolean" + }, + { + "description": "the 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 source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + } + ], + "related": "listPortForwardingRules,updatePortForwardingRule,updateIpv6FirewallRule", + "response": [ + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "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 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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the project id of the group", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, + {}, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "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 target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" - }, + } + ] + }, + { + "description": "Disables an account", + "isasync": true, + "name": "disableAccount", + "params": [ { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "If true, only lock the account; else disable the account", + "length": 255, + "name": "lock", + "required": true, "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Disables specified account in this domain.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Disables specified account.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "Account id", + "length": 255, + "name": "id", + "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + } + ], + "related": "createAccount,enableAccount,listAccounts,listAccounts", + "response": [ + { + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "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 projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + {}, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "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 list of nics associated with vm", - "name": "nic", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the name of the account", + "name": "name", + "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 total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "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 total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "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": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the account type of the user", + "name": "accounttype", "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the user email address", + "name": "email", "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "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 vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, + {}, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "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 user's name who deployed the virtual machine", - "name": "username", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of 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", "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" } ] }, { - "description": "Disables an account", - "isasync": true, - "name": "disableAccount", + "description": "Lists domains and provides detailed information for listed domains", + "isasync": false, + "name": "listDomains", "params": [ { - "description": "If true, only lock the account; else disable the account", + "description": "List domain by domain name.", "length": 255, - "name": "lock", - "required": true, - "type": "boolean" + "name": "name", + "required": false, + "type": "string" }, { - "description": "Account id", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Disables specified account.", + "description": "flag to display the resource icon for domains", "length": 255, - "name": "account", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Disables specified account in this domain.", + "description": "List domain by domain ID.", "length": 255, - "name": "domainid", + "name": "id", "related": "listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" - } - ], - "related": "createAccount,enableAccount,listAccounts,listAccounts", - "response": [ - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", + "length": 255, + "name": "details", + "required": false, + "type": "list" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, + "description": "List domains by domain level.", + "length": 255, + "name": "level", + "required": false, + "type": "integer" + } + ], + "related": "listDomainChildren,listDomains", + "response": [ { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the network domain", - "name": "networkdomain", + "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 account", - "name": "templateavailable", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "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": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", + "description": "the total primary storage space (in GiB) the domain can own", "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" }, + {}, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" }, + {}, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "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 number of projects the account can own", - "name": "projectlimit", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "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 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 email address", - "name": "email", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "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 ID of the user", - "name": "domainid", - "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", - "name": "rolename", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - } - ], - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the state of the account", - "name": "state", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "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 stored by this domain", + "name": "snapshottotal", + "type": "long" }, - {}, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "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 account", - "name": "secondarystorageavailable", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" } ] }, { - "description": "Lists domains and provides detailed information for listed domains", - "isasync": false, - "name": "listDomains", + "description": "Updates a network", + "isasync": true, + "name": "updateNetwork", "params": [ { - "description": "List domains by domain level.", + "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": "level", + "name": "ip6dns1", "required": false, - "type": "integer" + "since": "4.18.0", + "type": "string" }, { - "description": "List domain by domain ID.", + "description": "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains,listDomains", + "name": "updateinsequence", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", + "description": "the new name for the network", "length": 255, - "name": "details", + "name": "name", "required": false, - "type": "list" + "type": "string" }, { - "description": "", + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", "length": 255, - "name": "page", + "name": "hideipaddressusage", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "", + "description": "network offering ID", "length": 255, - "name": "pagesize", + "name": "networkofferingid", + "related": "listNetworkOfferings", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "network domain", "length": 255, - "name": "keyword", + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "flag to display the resource icon for domains", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "showicon", + "name": "customid", "required": false, - "type": "boolean" + "since": "4.4", + "type": "string" }, { - "description": "List domain by domain name.", + "description": "the new display text for the network", "length": 255, - "name": "name", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", "length": 255, - "name": "listall", + "name": "dns2", + "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" - } - ], - "related": "listDomainChildren,listDomains", - "response": [ + }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", + "length": 255, + "name": "guestvmcidr", + "required": false, "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "publicmtu", + "required": false, + "since": "4.18.0", + "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the network", + "length": 255, + "name": "id", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "length": 255, + "name": "displaynetwork", + "required": false, + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", + "length": 255, + "name": "ip6dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" + "description": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "privatemtu", + "required": false, + "since": "4.18.0", + "type": "integer" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", + "length": 255, + "name": "dns1", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - {}, + "description": "Setting this to true will cause a forced network update,", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + } + ], + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "response": [ { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, + {}, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "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 vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "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 date when this domain was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the path of the domain", - "name": "path", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the state of the domain", - "name": "state", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the name of the domain", - "name": "name", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the type of the network", + "name": "type", "type": "string" }, - {}, - { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" - }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" - } - ] - }, - { - "description": "Updates a network", - "isasync": true, - "name": "updateNetwork", - "params": [ - { - "description": "network domain", - "length": 255, + "description": "the network domain", "name": "networkdomain", - "required": false, "type": "string" }, { - "description": "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider", - "length": 255, - "name": "updateinsequence", - "required": false, - "type": "boolean" - }, - { - "description": "the new name for the network", - "length": 255, + "description": "the name of the network", "name": "name", - "required": false, "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "length": 255, - "name": "displaynetwork", - "required": false, + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "Force update even if CIDR type is different", - "length": 255, - "name": "changecidr", - "required": false, + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the ID of the network", - "length": 255, - "name": "id", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "description": "the name of the zone the network belongs to", + "name": "zonename", + "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, + "description": "true if network is system, false otherwise", + "name": "issystem", "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 domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the new display text for the network", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", - "length": 255, - "name": "guestvmcidr", - "required": false, + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": false, - "type": "uuid" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "Setting this to true will cause a forced network update,", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - } - ], - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "response": [ + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + {}, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "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 ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "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": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, - {}, { "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "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": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, - { - "description": "the first DNS for the network", - "name": "dns1", - "type": "string" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" - }, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "the type of the network", - "name": "type", - "type": "string" - }, - { - "description": "The external id of the network", - "name": "externalid", - "type": "string" - }, - {}, - { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, { "description": "The routes for the network to ease adding route in upstream router", "name": "ip6routes", "type": "set" }, { - "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": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "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 owner of the network", + "name": "account", "type": "string" - }, + } + ] + }, + { + "description": "List Usage Types", + "isasync": false, + "name": "listUsageTypes", + "params": [], + "related": "", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "description of usage type", + "name": "description", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" - }, + "description": "usage type", + "name": "usagetypeid", + "type": "integer" + } + ] + }, + { + "description": "Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state.", + "isasync": false, + "name": "resetUserDataForVirtualMachine", + "params": [ { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "an optional project for the virtual machine", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "type": "map" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, + "description": "the ID of the userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "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 type of the nic", + "name": "type", + "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the 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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + } + ], + "type": "set" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "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": "the list of services", - "name": "service", + "description": "the list of resource tags associated", + "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": "tag value", + "name": "value", + "type": "string" }, { - "description": "the service name", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" + "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], - "type": "list" - } - ] - }, - { - "description": "List Usage Types", - "isasync": false, - "name": "listUsageTypes", - "params": [], - "related": "", - "response": [ - { - "description": "description of usage type", - "name": "description", - "type": "string" + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "usage type", - "name": "usagetypeid", - "type": "integer" - }, - {}, - {} - ] - }, - { - "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", - "isasync": true, - "name": "deleteTemplate", - "params": [ - { - "description": "the ID of the template", - "length": 255, - "name": "id", - "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" - }, - { - "description": "Force delete a template.", - "length": 255, - "name": "forced", - "required": false, - "since": "4.9+", - "type": "boolean" - }, - { - "description": "the ID of zone of the template", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "response": [ - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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 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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Lists all network ACLs", - "isasync": false, - "name": "listNetworkACLLists", - "params": [ - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "list network ACLs by VPC ID", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "list network ACLs by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "list network ACLs by specified name", - "length": 255, - "name": "name", - "required": false, + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "Lists network ACL with the specified ID.", - "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - } - ], - "related": "createNetworkACLList", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { @@ -53995,404 +57644,713 @@ "type": "integer" }, { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the Name of the ACL", - "name": "name", - "type": "string" - }, - {}, - {}, - { - "description": "the ID of the ACL", - "name": "id", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, + {}, { - "description": "Description of the ACL", - "name": "description", - "type": "string" - } - ] - }, - { - "description": "Archives (moves) a snapshot on primary storage to secondary storage", - "isasync": true, - "name": "archiveSnapshot", - "params": [ - { - "description": "The ID of the snapshot", - "length": 255, - "name": "id", - "related": "archiveSnapshot,revertSnapshot", - "required": true, - "type": "uuid" - } - ], - "related": "revertSnapshot", - "response": [ - { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "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 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 name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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" + }, + { + "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 project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, + {}, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, + {}, { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, - {}, { - "description": "name of the snapshot", - "name": "name", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "id of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, - {}, { - "description": "the 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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" - } - ] - }, - { - "description": "Deletes a VPC", - "isasync": true, - "name": "deleteVPC", - "params": [ + }, { - "description": "the ID of the VPC", - "length": 255, - "name": "id", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" - } - ] - }, - { - "description": "Updates site to site vpn local gateway", - "isasync": true, - "name": "updateVpnGateway", - "params": [ + }, { - "description": "id of customer gateway", - "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", - "required": true, - "type": "uuid" + "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 vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" - } - ], - "related": "createVpnGateway,listVpnGateways", - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, - {}, - {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the owner", - "name": "account", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" } ], - "since": "4.4" + "since": "4.18.0" }, { - "description": "Releases a dedicated guest vlan range to the system", + "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", "isasync": true, - "name": "releaseDedicatedGuestVlanRange", + "name": "deleteTemplate", "params": [ { - "description": "the ID of the dedicated guest vlan range", + "description": "the ID of zone of the template", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "Force delete a template.", + "length": 255, + "name": "forced", + "required": false, + "since": "4.9+", + "type": "boolean" + }, + { + "description": "the ID of the template", "length": 255, "name": "id", - "related": "", + "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": true, "type": "uuid" } ], "response": [ - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "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", @@ -54401,42 +58359,101 @@ ] }, { - "description": "Deletes security group", + "description": "Lists all network ACLs", "isasync": false, - "name": "deleteSecurityGroup", + "name": "listNetworkACLLists", "params": [ { - "description": "The ID of the security group. Mutually exclusive with id parameter", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list network ACLs by specified name", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "the account of the security group. Must be specified with domain ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "list network ACLs by VPC ID", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "The ID of the security group. Mutually exclusive with name parameter", + "description": "list network ACLs by network ID", "length": 255, - "name": "id", - "related": "createSecurityGroup", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "the domain ID of account owning the security group", + "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": "Lists network ACL with the specified ID.", + "length": 255, + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, "type": "uuid" }, { - "description": "the project of the security group", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", @@ -54444,597 +58461,556 @@ "type": "uuid" } ], + "related": "createNetworkACLList", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Name of the ACL", + "name": "name", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the ACL", + "name": "id", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", + "type": "string" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Description of the ACL", + "name": "description", "type": "string" - } - ] - }, - { - "description": "Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool", - "isasync": true, - "name": "migrateVirtualMachine", - "params": [ + }, { - "description": "Destination Host ID to migrate VM to.", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": false, - "type": "uuid" + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", + "type": "string" }, { - "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", - "length": 255, - "name": "autoselect", - "required": false, - "since": "4.16.0", + "description": "is ACL for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ] + }, + { + "description": "Archives (moves) a snapshot on primary storage to secondary storage", + "isasync": true, + "name": "archiveSnapshot", + "params": [ + { + "description": "The ID of the snapshot", "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "id", + "related": "archiveSnapshot,revertSnapshot", "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,importUnmanagedInstance", + "related": "revertSnapshot", "response": [ { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "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.", + "name": "locationtype", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "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 host for the virtual machine", - "name": "hostid", + "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 date the snapshot was created", + "name": "created", + "type": "date" }, { - "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": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the 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 description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the security group", + "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 number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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 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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "name of the snapshot", + "name": "name", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", "type": "long" + } + ] + }, + { + "description": "Deletes a VPC", + "isasync": true, + "name": "deleteVPC", + "params": [ + { + "description": "the ID of the VPC", + "length": 255, + "name": "id", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, + {}, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Updates site to site vpn local gateway", + "isasync": true, + "name": "updateVpnGateway", + "params": [ + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "an optional field, whether to the display the vpn to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "id of customer gateway", + "length": 255, + "name": "id", + "related": "createVpnGateway,listVpnGateways,updateVpnGateway", + "required": true, + "type": "uuid" + } + ], + "related": "createVpnGateway,listVpnGateways", + "response": [ + {}, + { + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "the vpn gateway ID", "name": "id", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id", + "name": "projectid", + "type": "string" + }, + { + "description": "the public IP address", + "name": "publicip", + "type": "string" + }, + { + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the vpc id of this gateway", + "name": "vpcid", + "type": "string" + } + ], + "since": "4.4" + }, + { + "description": "Releases a dedicated guest vlan range to the system", + "isasync": true, + "name": "releaseDedicatedGuestVlanRange", + "params": [ + { + "description": "the ID of the dedicated guest vlan range", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "Deletes security group", + "isasync": false, + "name": "deleteSecurityGroup", + "params": [ + { + "description": "the domain ID of account owning the security group", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the account of the security group. Must be specified with domain ID", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the name of the virtual machine", + "description": "The ID of the security group. Mutually exclusive with name parameter", + "length": 255, + "name": "id", + "related": "createSecurityGroup", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the security group. Mutually exclusive with id parameter", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the project of the security group", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool", + "isasync": true, + "name": "migrateVirtualMachine", + "params": [ + { + "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", + "length": 255, + "name": "autoselect", + "required": false, + "since": "4.16.0", "type": "boolean" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "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,importUnmanagedInstance", + "required": true, + "type": "uuid" }, + { + "description": "Destination Host ID to migrate VM to.", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + } + ], + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ { "description": "the vGPU type used by the virtual machine", "name": "vgpu", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the 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": "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": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { @@ -55043,174 +59019,168 @@ "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "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" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { "description": "the hypervisor on which the template runs", "name": "hypervisor", "type": "string" }, + {}, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "OS name of the vm", + "name": "osdisplayname", "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": "ssh key-pairs", - "name": "keypairs", + "description": "device type of the root volume", + "name": "rootdevicetype", "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": "publicip", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "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": "the account associated with the tag", - "name": "account", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the traffic type of the nic", + "name": "traffictype", "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": "the name of the corresponding network", + "name": "networkname", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ + }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -55219,23 +59189,23 @@ "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -55243,178 +59213,742 @@ "name": "ip6gateway", "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 ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "the extra dhcp options on the nic", "name": "extradhcpoption", "type": "list" }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, { "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + } + ], + "type": "set" + }, + { + "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 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": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the ID of the security group", + "name": "id", + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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": "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" + } + ], + "type": "set" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the 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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "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" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the description of the security group", + "name": "description", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "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": "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": "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 ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "id of the resource", + "name": "resourceid", "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": "isdefault", - "type": "boolean" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, - {}, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + {}, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, + {}, { - "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": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the 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 state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the domain name of the affinity group", + "name": "domain", "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 type of the affinity group", - "name": "type", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { @@ -55423,13 +59957,13 @@ "type": "list" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -55441,34 +59975,29 @@ "type": "set" }, { - "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "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": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" } ] }, @@ -55487,15 +60016,16 @@ } ], "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", @@ -55504,11 +60034,10 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -55517,40 +60046,26 @@ "name": "createTemplate", "params": [ { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", + "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", + "length": 2048, + "name": "url", "required": false, "type": "string" }, { - "description": "Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal", - "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "type": "uuid" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "the name of the template", "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" - }, - { - "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", - "length": 2048, - "name": "url", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "true if this template is a public template, false otherwise", + "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": "ispublic", + "name": "volumeid", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "32 or 64 bit", @@ -55560,11 +60075,12 @@ "type": "integer" }, { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": true, - "type": "string" + "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", + "length": 255, + "name": "snapshotid", + "related": "revertSnapshot", + "required": false, + "type": "uuid" }, { "description": "true if the template supports the password reset feature; default is false", @@ -55573,14 +60089,6 @@ "required": false, "type": "boolean" }, - { - "description": "the ID of the OS Type that best represents the OS of this template.", - "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": true, - "type": "uuid" - }, { "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, @@ -55588,6 +60096,13 @@ "required": false, "type": "map" }, + { + "description": "true if the template requires HVM, false otherwise", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" + }, { "description": "true if this template is a featured template, false otherwise", "length": 255, @@ -55596,24 +60111,24 @@ "type": "boolean" }, { - "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "isdynamicallyscalable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "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": "sshkeyenabled", + "name": "virtualmachineid", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if the template requires HVM, false otherwise", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "requireshvm", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, @@ -55626,122 +60141,216 @@ "type": "uuid" }, { - "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": true, + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", "length": 255, - "name": "snapshotid", - "related": "revertSnapshot", + "name": "ispublic", "required": false, + "type": "boolean" + }, + { + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "type": "string" + }, + { + "description": "the ID of the OS Type that best represents the OS of this template.", + "length": 255, + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", + "required": true, "type": "uuid" + } + ], + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "response": [ + { + "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": "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 size of the template", + "name": "size", + "type": "long" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the name of the template", - "length": 255, - "name": "name", - "required": true, + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" - } - ], - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "response": [ + }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, - {}, { "description": "the ID of the zone for this template", "name": "zoneid", "type": "string" }, - {}, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "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 project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the 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 ID of the OS type for this template.", - "name": "ostypeid", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "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": "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": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "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 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": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -55750,91 +60359,36 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the 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": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "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 date this template was created", + "name": "created", + "type": "date" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { @@ -55843,44 +60397,39 @@ "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the template name", - "name": "name", - "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 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": "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", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { "description": "the template display text", @@ -55888,63 +60437,63 @@ "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the project name of the template", - "name": "project", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" } ] @@ -55978,28 +60527,28 @@ ], "related": "addBaremetalRct", "response": [ - {}, { - "description": "id of rct", - "name": "id", + "description": "url", + "name": "url", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "url", - "name": "url", + "description": "id of rct", + "name": "id", "type": "string" - }, - {} + } ] }, { @@ -56007,6 +60556,13 @@ "isasync": true, "name": "uploadCustomCertificate", "params": [ + { + "description": "The private key for the attached certificate.", + "length": 65535, + "name": "privatekey", + "required": false, + "type": "string" + }, { "description": "DNS domain suffix that the certificate is granted for.", "length": 255, @@ -56014,6 +60570,13 @@ "required": true, "type": "string" }, + { + "description": "An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3", + "length": 255, + "name": "id", + "required": false, + "type": "integer" + }, { "description": "The certificate to be uploaded.", "length": 65535, @@ -56027,40 +60590,26 @@ "name": "name", "required": false, "type": "string" - }, - { - "description": "The private key for the attached certificate.", - "length": 65535, - "name": "privatekey", - "required": false, - "type": "string" - }, - { - "description": "An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3", - "length": 255, - "name": "id", - "required": false, - "type": "integer" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "message of the certificate upload operation", "name": "message", "type": "string" }, {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -56070,27 +60619,25 @@ "name": "listDedicatedClusters", "params": [ { - "description": "the ID of the domain associated with the cluster", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "the name of the account associated with the cluster. Must be used with domainId.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the cluster", + "description": "List by keyword", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list dedicated clusters by affinity group", @@ -56101,70 +60648,72 @@ "type": "uuid" }, { - "description": "", + "description": "the ID of the domain associated with the cluster", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the name of the account associated with the cluster. Must be used with domainId.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of the cluster", "length": 255, - "name": "keyword", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ + { + "description": "the Account ID of the cluster", + "name": "accountid", + "type": "string" + }, { "description": "the name of the cluster", "name": "clustername", "type": "string" }, { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the domain ID of the cluster", + "name": "domainid", "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": "the ID of the cluster", "name": "clusterid", "type": "string" }, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -56183,28 +60732,28 @@ ], "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 description of the CA service provider", "name": "description", "type": "string" }, + {}, { "description": "the CA service provider name", "name": "name", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.11.0" }, @@ -56223,23 +60772,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": "the current status of the latest async job acting 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", @@ -56253,18 +60802,56 @@ "name": "listPortForwardingRules", "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": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of IP address of the port forwarding services", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "page", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -56275,19 +60862,28 @@ "type": "uuid" }, { - "description": "Lists rule with the specified ID.", + "description": "list port forwarding rules for certain network", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.3", "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": "Lists rule with the specified ID.", + "length": 255, + "name": "id", + "related": "listPortForwardingRules,updatePortForwardingRule,updateIpv6FirewallRule", + "required": false, + "type": "uuid" }, { "description": "", @@ -56297,65 +60893,59 @@ "type": "integer" }, { - "description": "list port forwarding rules for certain network", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "page", "required": false, - "since": "4.3", - "type": "uuid" + "type": "integer" + } + ], + "related": "updatePortForwardingRule,updateIpv6FirewallRule", + "response": [ + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "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 starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" }, + {}, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" }, { - "description": "the ID of IP address of the port forwarding services", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the 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" - } - ], - "related": "updateIpv6FirewallRule,updatePortForwardingRule", - "response": [ + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { @@ -56363,14 +60953,40 @@ "name": "id", "type": "string" }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the 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": "is firewall for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -56378,13 +60994,13 @@ "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": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -56393,114 +61009,47 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, { "description": "the ending port of port forwarding rule's private port range", "name": "privateendport", "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, - {}, - {}, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" } ] }, @@ -56528,26 +61077,41 @@ ], "related": "", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "MAC address of the pod the IP", + "name": "hostmac", + "type": "long" + }, + { + "description": "the ID of the pod the IP address", + "name": "id", + "type": "long" + }, + { + "description": "Allocated IP address", + "name": "ipaddress", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Gateway for Pod ", "name": "gateway", "type": "string" }, - {}, { "description": "the ID of the nic", "name": "nicid", "type": "long" }, { - "description": "MAC address of the pod the IP", - "name": "hostmac", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the ID of the pod the IP address belongs to", @@ -56555,25 +61119,10 @@ "type": "long" }, {}, - { - "description": "the ID of the pod the IP address", - "name": "id", - "type": "long" - }, { "description": "CIDR of the Pod", "name": "cidr", "type": "string" - }, - { - "description": "Allocated IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -56594,13 +61143,18 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", "response": [ { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "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 interface username", + "name": "username", "type": "string" }, { @@ -56608,33 +61162,26 @@ "name": "status", "type": "boolean" }, - {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "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": "true if out-of-band management is enabled for the host", "name": "enabled", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the out-of-band management interface password", "name": "password", "type": "string" }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, { "description": "the operation result description", "name": "description", @@ -56646,43 +61193,115 @@ "type": "powerstate" }, { - "description": "the current status of the latest async job acting 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", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, + {}, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the ID of the host", + "name": "hostid", "type": "string" } ], "since": "4.9.0" }, { - "description": "Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A priviledged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.", + "description": "list Tungsten-Fabric network", "isasync": false, - "name": "updateTemplatePermissions", + "name": "listTungstenFabricNetwork", "params": [ { - "description": "the template ID", + "description": "the ID of zone", "length": 255, - "name": "id", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, "type": "uuid" }, { - "description": "true for featured template/iso, false otherwise", + "description": "", "length": 255, - "name": "isfeatured", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric network", + "length": 255, + "name": "networkuuid", + "required": false, + "type": "string" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false", + "length": 255, + "name": "listall", "required": false, "type": "boolean" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric network name", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric network uuid", + "name": "uuid", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {} + ] + }, + { + "description": "Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.", + "isasync": false, + "name": "updateTemplatePermissions", + "params": [ { "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", "length": 255, @@ -56706,27 +61325,36 @@ "type": "list" }, { - "description": "permission operator (add, remove, reset)", + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "op", + "name": "accounts", "required": false, - "type": "string" + "type": "list" }, { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "the template ID", "length": 255, - "name": "accounts", + "name": "id", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" + }, + { + "description": "true for featured template/iso, false otherwise", + "length": 255, + "name": "isfeatured", "required": false, - "type": "list" + "type": "boolean" + }, + { + "description": "permission operator (add, remove, reset)", + "length": 255, + "name": "op", + "required": false, + "type": "string" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -56738,11 +61366,17 @@ "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" - } + }, + {} ] }, { @@ -56782,6 +61416,11 @@ ], "related": "addTrafficMonitor", "response": [ + { + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" + }, { "description": "the number of times to retry requests to the external firewall", "name": "numretries", @@ -56792,6 +61431,13 @@ "name": "zoneid", "type": "string" }, + {}, + { + "description": "the management IP address of the external firewall", + "name": "ipaddress", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -56802,22 +61448,10 @@ "name": "id", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" - }, - {}, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" } ] }, @@ -56838,441 +61472,250 @@ "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "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", + "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + {}, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "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", + "description": "the ID of 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", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the project name of the group", + "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 domain name of the affinity group", + "name": "domain", + "type": "string" }, { - "description": "the ID of the security group", + "description": "the ID of the affinity group", "name": "id", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "type": "set" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the name of the security group", - "name": "name", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the domain ID of the security group", + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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 name of the affinity group", + "name": "name", + "type": "string" }, { - "description": "the project id of the group", + "description": "the project ID of the affinity group", "name": "projectid", "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" } ], "type": "set" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "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": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, + {}, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, + {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "the list of resource tags associated", + "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": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { @@ -57281,379 +61724,283 @@ "type": "long" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the group name of the virtual machine", + "name": "group", "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": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, - {}, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", + "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": "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 backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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", + "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": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "true if 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", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "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 password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "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 ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "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 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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the nic", - "name": "id", + "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { "description": "the isolated private VLAN if available", @@ -57661,13 +62008,8 @@ "type": "integer" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -57676,126 +62018,463 @@ "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" - }, + } + ], + "type": "set" + }, + { + "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "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 id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the security group", + "name": "id", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "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 domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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" + }, + { + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "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 domain in which the virtual machine exists", - "name": "domain", + "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" } ] @@ -57805,6 +62484,22 @@ "isasync": true, "name": "updatePortForwardingRule", "params": [ + { + "description": "the ID of the port forwarding rule", + "length": 255, + "name": "id", + "related": "updatePortForwardingRule,updateIpv6FirewallRule", + "required": true, + "since": "4.4", + "type": "uuid" + }, + { + "description": "the private start port of the port forwarding rule", + "length": 255, + "name": "privateport", + "required": false, + "type": "integer" + }, { "description": "VM guest nic Secondary ip address for the port forwarding rule", "length": 255, @@ -57814,11 +62509,12 @@ "type": "string" }, { - "description": "the private end port of the port forwarding rule", + "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, - "name": "privateendport", + "name": "virtualmachineid", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -57828,15 +62524,6 @@ "since": "4.4", "type": "string" }, - { - "description": "the ID of the port forwarding rule", - "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule,updatePortForwardingRule", - "required": true, - "since": "4.4", - "type": "uuid" - }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -57846,17 +62533,9 @@ "type": "boolean" }, { - "description": "the ID of the virtual machine for the port forwarding rule", - "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "type": "uuid" - }, - { - "description": "the private start port of the port forwarding rule", + "description": "the private end port of the port forwarding rule", "length": 255, - "name": "privateport", + "name": "privateendport", "required": false, "type": "integer" } @@ -57864,29 +62543,8 @@ "related": "updateIpv6FirewallRule", "response": [ { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "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 VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { @@ -57894,8 +62552,8 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -57904,87 +62562,113 @@ "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": "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 account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, - {}, { "description": "the 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", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + {}, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the 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", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, + {}, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { @@ -57993,8 +62677,8 @@ "type": "integer" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { @@ -58003,13 +62687,8 @@ "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" } ] @@ -58019,6 +62698,13 @@ "isasync": false, "name": "listBrocadeVcsDevices", "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "Brocade VCS switch ID", "length": 255, @@ -58028,11 +62714,11 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "the Physical Network ID", @@ -58048,53 +62734,46 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "name of the provider", - "name": "provider", + "description": "the physical Network to which this Brocade VCS 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 principal switch Ip address", "name": "hostname", "type": "string" }, { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, { "description": "device id of the Brocade Vcs", "name": "vcsdeviceid", "type": "string" }, { - "description": "device name", - "name": "brocadedevicename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "device name", + "name": "brocadedevicename", + "type": "string" } ] }, @@ -58104,11 +62783,12 @@ "name": "linkDomainToLdap", "params": [ { - "description": "domain admin username in LDAP ", + "description": "The id of the domain which has to be linked to LDAP.", "length": 255, - "name": "admin", - "required": false, - "type": "string" + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": true, + "type": "uuid" }, { "description": "type of the ldap name. GROUP or OU", @@ -58117,25 +62797,17 @@ "required": true, "type": "string" }, - { - "description": "The id of the domain which has to be linked to LDAP.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" - }, { "description": "name of the group or OU in LDAP", "length": 255, - "name": "name", + "name": "ldapdomain", "required": false, "type": "string" }, { - "description": "name of the group or OU in LDAP", + "description": "domain admin username in LDAP ", "length": 255, - "name": "ldapdomain", + "name": "admin", "required": false, "type": "string" }, @@ -58145,20 +62817,26 @@ "name": "accounttype", "required": true, "type": "integer" + }, + { + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "linkAccountToLdap", "response": [ - {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", "type": "string" }, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", + "description": "type of the name in LDAP which is linke to the domain", + "name": "type", "type": "string" }, { @@ -58167,14 +62845,15 @@ "type": "string" }, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Type of the account to auto import", @@ -58182,13 +62861,13 @@ "type": "int" }, { - "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 name in LDAP which is linke to the domain", - "name": "type", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", "type": "string" } ], @@ -58199,6 +62878,21 @@ "isasync": true, "name": "associateIpAddress", "params": [ + { + "description": "the ID of the domain to associate with this IP address", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "IP Address to be associated", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, { "description": "the VPC you want the IP address to be associated with", "length": 255, @@ -58219,7 +62913,7 @@ "description": "The network this IP address should be associated to.", "length": 255, "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, @@ -58230,14 +62924,6 @@ "required": false, "type": "boolean" }, - { - "description": "region ID from where portable IP is to be associated.", - "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", - "required": false, - "type": "integer" - }, { "description": "the ID of the availability zone you want to acquire an public IP address from", "length": 255, @@ -58247,16 +62933,17 @@ "type": "uuid" }, { - "description": "the account to associate with this IP address", + "description": "region ID from where portable IP is to be associated.", "length": 255, - "name": "account", + "name": "regionid", + "related": "addRegion,listRegions", "required": false, - "type": "string" + "type": "integer" }, { - "description": "IP Address to be associated", + "description": "the account to associate with this IP address", "length": 255, - "name": "ipaddress", + "name": "account", "required": false, "type": "string" }, @@ -58267,21 +62954,79 @@ "required": false, "since": "4.4", "type": "boolean" - }, - { - "description": "the ID of the domain to associate with this IP address", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" } ], "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, + { + "description": "public IP address id", + "name": "id", + "type": "string" + }, + { + "description": "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": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + {}, + { + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { @@ -58290,32 +63035,33 @@ "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, + { + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" + }, + {}, { "description": "the list of resource tags associated with ip address", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -58324,13 +63070,13 @@ "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 name where tag belongs to", + "name": "project", "type": "string" }, { @@ -58338,6 +63084,11 @@ "name": "projectid", "type": "string" }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, { "description": "the ID of the domain associated with the tag", "name": "domainid", @@ -58347,28 +63098,23 @@ "description": "tag key name", "name": "key", "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "list" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { @@ -58377,18 +63123,23 @@ "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "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" }, { @@ -58397,13 +63148,13 @@ "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { @@ -58412,13 +63163,13 @@ "type": "boolean" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachineid", "type": "string" }, { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { @@ -58427,29 +63178,42 @@ "type": "string" }, { - "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachineid", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, - {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" - }, + } + ] + }, + { + "description": "Get the SF Volume Access Group IDs", + "isasync": false, + "name": "getSolidFireVolumeAccessGroupIds", + "params": [ { - "description": "public IP address id", - "name": "id", + "description": "Storage Pool UUID", + "length": 255, + "name": "storageid", + "required": true, "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "Cluster UUID", + "length": 255, + "name": "clusterid", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -58458,98 +63222,78 @@ "type": "integer" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "SolidFire Volume Access Group Ids", + "name": "solidFireVolumeAccessGroupIds", + "type": "long[]" }, + {}, + {} + ] + }, + { + "description": "Setup the 2FA for the user.", + "isasync": false, + "name": "setupUserTwoFactorAuthentication", + "params": [ { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "optional: the id of the user for which 2FA has to be disabled", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "type": "uuid" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "Enabled by default, provide false to disable 2FA", + "length": 255, + "name": "enable", + "required": false, "type": "boolean" }, - {}, - { - "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", + "description": "two factor authentication code", + "length": 255, + "name": "provider", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "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", + "description": "the user ID", + "name": "id", "type": "string" }, + {}, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" - }, - { - "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinename", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ] - }, - { - "description": "Get the SF Volume Access Group IDs", - "isasync": false, - "name": "getSolidFireVolumeAccessGroupIds", - "params": [ - { - "description": "Cluster UUID", - "length": 255, - "name": "clusterid", - "required": true, + "description": "the user name", + "name": "username", "type": "string" }, - { - "description": "Storage Pool UUID", - "length": 255, - "name": "storageid", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "SolidFire Volume Access Group Ids", - "name": "solidFireVolumeAccessGroupIds", - "type": "long[]" - }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "secret code that needs to be registered with authenticator", + "name": "secretcode", + "type": "string" } - ] + ], + "since": "4.18.0" }, { "description": "Delete site to site vpn connection", @@ -58567,10 +63311,11 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -58582,11 +63327,10 @@ "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" } ] }, @@ -58596,115 +63340,124 @@ "name": "createNetworkACL", "params": [ { - "description": "type of the ICMP message being sent", + "description": "The network of the VM the ACL will be created for", "length": 255, - "name": "icmptype", + "name": "aclid", + "related": "createNetworkACLList", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "scl entry action, allow or deny", + "description": "The network of the VM the ACL will be created for", "length": 255, - "name": "action", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ending port of ACL", + "description": "the starting port of ACL", "length": 255, - "name": "endport", + "name": "startport", "required": false, "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "fordisplay", + "name": "traffictype", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "The network of the VM the ACL will be created for", + "description": "The number of the ACL item, its ordering", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "number", "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": "type of the ICMP message being sent", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the starting port of ACL", + "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "startport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "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": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "traffictype", - "required": false, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "error code for this ICMP message", + "description": "scl entry action, allow or deny", "length": 255, - "name": "icmpcode", + "name": "action", "required": false, - "type": "integer" + "type": "string" }, { - "description": "The number of the ACL item, its ordering", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "number", + "name": "reason", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "the ending port of ACL", "length": 255, - "name": "cidrlist", + "name": "endport", "required": false, - "type": "list" + "type": "integer" }, { - "description": "The network of the VM the ACL will be created for", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" } ], "related": "updateNetworkACLItem,moveNetworkAclItem", "response": [ - {}, + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + { + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" + }, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -58713,33 +63466,33 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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" }, { @@ -58751,18 +63504,23 @@ "type": "list" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { @@ -58771,69 +63529,55 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, {}, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { "description": "the ending port of ACL's port range", "name": "endport", "type": "string" }, + {}, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "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": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the state of the rule", + "name": "state", "type": "string" } ] @@ -58844,19 +63588,19 @@ "name": "resetSSHKeyForVirtualMachine", "params": [ { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "account", + "name": "keypair", "required": false, "type": "string" }, { - "description": "names of the ssh key pairs to be used to login to the virtual machine", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "keypairs", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.17", - "type": "list" + "type": "uuid" }, { "description": "The ID of the virtual machine", @@ -58875,51 +63619,52 @@ "type": "uuid" }, { - "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": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "names of the ssh key pairs to be used to login to the virtual machine", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "keypairs", "required": false, - "type": "uuid" + "since": "4.17", + "type": "list" } ], "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, + {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "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", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { @@ -58928,27 +63673,59 @@ "type": "map" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + { + "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": "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", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { @@ -58956,13 +63733,13 @@ "name": "egressrule", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -58971,22 +63748,37 @@ "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -58994,14 +63786,19 @@ "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", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -59009,24 +63806,14 @@ "name": "domain", "type": "string" }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" } ], @@ -59038,52 +63825,22 @@ "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 protocol of the security group rule", "name": "protocol", "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the ID of the security group", @@ -59095,13 +63852,13 @@ "name": "ingressrule", "response": [ { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -59110,98 +63867,98 @@ "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 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", + "description": "the protocol of the security group rule", + "name": "protocol", "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": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -59209,23 +63966,18 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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" }, { @@ -59234,8 +63986,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -59244,8 +63996,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -59254,39 +64006,166 @@ "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", "type": "string" } ], "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" } ], "type": "set" }, { - "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": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "OS name of the vm", + "name": "osdisplayname", "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": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -59295,23 +64174,83 @@ "type": "date" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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", + "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 name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -59320,13 +64259,28 @@ "type": "long" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { @@ -59334,53 +64288,158 @@ "name": "jobstatus", "type": "integer" }, + { + "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 project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, { "description": "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "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 name of the affinity group", - "name": "name", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { @@ -59388,27 +64447,27 @@ "name": "virtualmachineIds", "type": "list" }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, { "description": "the description of the affinity group", "name": "description", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { @@ -59416,38 +64475,13 @@ "name": "nic", "response": [ { - "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 gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -59456,18 +64490,8 @@ "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -59476,13 +64500,8 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -59491,18 +64510,18 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -59511,13 +64530,13 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { @@ -59526,332 +64545,102 @@ "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 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 vpc to which the nic belongs", - "name": "vpcid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" - } - ], - "type": "set" - }, - { - "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": "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the 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 group ID of the virtual machine", - "name": "groupid", - "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 ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ + }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ip address of the nic", + "name": "ipaddress", "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", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" } ], "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the 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": "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": "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" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - {}, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "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": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - {}, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the virtual machine", + "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" } ] }, @@ -59861,9 +64650,9 @@ "name": "listVpnCustomerGateways", "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" }, @@ -59875,13 +64664,6 @@ "required": false, "type": "uuid" }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, { "description": "id of the customer gateway", "length": 255, @@ -59898,77 +64680,78 @@ "type": "integer" }, { - "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": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "list 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": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "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" } ], "related": "createVpnCustomerGateway", "response": [ - {}, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the owner", + "name": "account", + "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" }, - {}, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, + {}, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -59976,25 +64759,20 @@ "name": "cidrlist", "type": "string" }, - { - "description": "the owner", - "name": "account", - "type": "string" - }, { "description": "IPsec policy of customer gateway", "name": "esppolicy", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "the project name", - "name": "project", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { "description": "true if the entity/resource has annotations", @@ -60002,49 +64780,60 @@ "type": "boolean" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "the project name", + "name": "project", + "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the date and time the host was removed", "name": "removed", "type": "date" }, + {}, { - "description": "the project id", - "name": "projectid", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" } ] }, @@ -60053,13 +64842,6 @@ "isasync": true, "name": "deleteManagementNetworkIpRange", "params": [ - { - "description": "The ending IP address.", - "length": 255, - "name": "endip", - "required": true, - "type": "string" - }, { "description": "The starting IP address.", "length": 255, @@ -60081,188 +64863,13 @@ "name": "vlan", "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" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ], - "since": "4.11.0.0" - }, - { - "description": "Add a supported Kubernetes version", - "isasync": false, - "name": "addKubernetesSupportedVersion", - "params": [ - { - "description": "the ID of the zone in which Kubernetes supported version will be available", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the minimum number of CPUs to be set with the Kubernetes version", - "length": 255, - "name": "mincpunumber", - "required": true, - "type": "integer" - }, - { - "description": "the name of the Kubernetes supported version", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the minimum RAM size in MB to be set with the Kubernetes version", - "length": 255, - "name": "minmemory", - "required": true, - "type": "integer" }, { - "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", + "description": "The ending IP address.", "length": 255, - "name": "semanticversion", + "name": "endip", "required": true, "type": "string" - }, - { - "description": "the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, - "type": "string" - }, - { - "description": "the URL of the binaries ISO for Kubernetes supported version", - "length": 255, - "name": "url", - "required": false, - "type": "string" - } - ], - "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", - "response": [ - { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" - }, - { - "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": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" - }, - { - "description": "Kubernetes semantic version", - "name": "semanticversion", - "type": "string" - }, - { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", - "type": "string" - }, - { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", - "type": "string" - }, - { - "description": "Name of the Kubernetes supported version", - "name": "name", - "type": "string" - }, - { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", - "type": "string" - }, - { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", - "type": "string" - }, - { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" - }, - {}, - { - "description": "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": "Deletes a Kubernetes cluster", - "isasync": true, - "name": "deleteKubernetesCluster", - "params": [ - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" } ], "response": [ @@ -60271,11 +64878,6 @@ "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", @@ -60283,566 +64885,280 @@ "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} - ] - }, - { - "description": "Creates a global load balancer rule", - "isasync": true, - "name": "createGlobalLoadBalancerRule", - "params": [ - { - "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", - "length": 255, - "name": "gslblbmethod", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ], + "since": "4.11.0.0" + }, + { + "description": "Add a supported Kubernetes version", + "isasync": false, + "name": "addKubernetesSupportedVersion", + "params": [ { - "description": "the domain ID associated with the load balancer", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "domain name for the GSLB service.", + "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", "length": 255, - "name": "gslbdomainname", + "name": "semanticversion", "required": true, "type": "string" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "description": "the name of the Kubernetes supported version", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "name of the load balancer rule", + "description": "the URL of the binaries ISO for Kubernetes supported version", "length": 255, - "name": "name", - "required": true, + "name": "url", + "required": false, "type": "string" }, { - "description": "region where the global load balancer is going to be created.", + "description": "the minimum RAM size in MB to be set with the Kubernetes version", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "minmemory", "required": true, "type": "integer" }, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "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": "gslbstickysessionmethodname", + "name": "checksum", "required": false, "type": "string" }, { - "description": "GSLB service type (tcp, udp, http)", + "description": "the minimum number of CPUs to be set with the Kubernetes version", "length": 255, - "name": "gslbservicetype", + "name": "mincpunumber", "required": true, - "type": "string" + "type": "integer" } ], - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ { - "description": "global load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", - "type": "string" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", "type": "integer" }, - {}, { - "description": "List of load balancer rules that are part of GSLB rule", - "name": "loadbalancerrule", - "response": [ - { - "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 loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "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": "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 name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - } - ], - "type": "list" + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", + "type": "string" }, { - "description": "name of the global load balancer rule", + "description": "Name of the Kubernetes supported version", "name": "name", "type": "string" }, + {}, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, + {}, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - {} + { + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" + } ] }, { - "description": " delete a netscaler load balancer device", + "description": "Deletes a Kubernetes cluster", "isasync": true, - "name": "deleteNetscalerLoadBalancer", + "name": "deleteKubernetesCluster", "params": [ { - "description": "netscaler load balancer device ID", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", "required": true, "type": "uuid" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Lists load balancer rules.", - "isasync": false, - "name": "listGlobalLoadBalancerRules", - "params": [ - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "Creates a global load balancer rule", + "isasync": true, + "name": "createGlobalLoadBalancerRule", + "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "GSLB service type (tcp, udp, http)", "length": 255, - "name": "keyword", - "required": false, + "name": "gslbservicetype", + "required": true, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the global load balancer rule", - "length": 255, - "name": "id", - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", - "required": false, - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "region ID", + "description": "session sticky method (sourceip) if not specified defaults to sourceip", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "gslbstickysessionmethodname", "required": false, - "type": "integer" - } - ], - "related": "updateGlobalLoadBalancerRule", - "response": [ - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "name of the global load balancer rule", - "name": "name", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", - "type": "string" - }, - { - "description": "global load balancer rule ID", - "name": "id", - "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": "List of load balancer rules that are part of GSLB rule", - "name": "loadbalancerrule", - "response": [ - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the list of resource tags associated with load balancer", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, + "description": "domain name for the GSLB service.", + "length": 255, + "name": "gslbdomainname", + "required": true, + "type": "string" + }, + { + "description": "load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", + "length": 255, + "name": "gslblbmethod", + "required": false, + "type": "string" + }, + { + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "the domain ID associated with the load balancer", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "name of the load balancer rule", + "length": 255, + "name": "name", + "required": true, + "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" + } + ], + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "response": [ + { + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", + "response": [ { - "description": "the public ip address", - "name": "publicip", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { @@ -60851,13 +65167,13 @@ "type": "boolean" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { @@ -60866,8 +65182,8 @@ "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { @@ -60876,8 +65192,13 @@ "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { @@ -60886,13 +65207,13 @@ "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { @@ -60906,101 +65227,221 @@ "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, + { + "description": "the list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" + }, { "description": "the public port", "name": "publicport", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" } ], "type": "list" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "global load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, { "description": "GSLB service type", "name": "gslbservicetype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", + "type": "string" + }, + { + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, + {}, { "description": "Region Id in which global load balancer is created", "name": "regionid", "type": "integer" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "name of the global load balancer rule", + "name": "name", "type": "string" } ] }, { - "description": "Updates a disk offering.", + "description": "Link or unlink a userdata to a template.", "isasync": false, - "name": "deleteDiskOffering", + "name": "linkUserDataToTemplate", "params": [ { - "description": "ID of the disk offering", + "description": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", "length": 255, - "name": "id", - "related": "createDiskOffering,listDiskOfferings", - "required": true, + "name": "userdatapolicy", + "required": false, + "type": "string" + }, + { + "description": "the ID of the ISO for the virtual machine", + "length": 255, + "name": "isoid", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, "type": "uuid" } ], + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "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", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -61010,638 +65451,710 @@ }, {}, { - "description": "true if operation is executed successfully", - "name": "success", + "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 resource tag(s)", - "isasync": false, - "name": "listTags", - "params": [ + }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project id of the template", "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "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.", - "length": 255, - "name": "isrecursive", - "required": false, + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "list by resource type", - "length": 255, - "name": "resourcetype", - "required": false, + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "list by resource id", - "length": 255, - "name": "resourceid", - "required": false, + "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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, + {}, { - "description": "list by value", - "length": 255, - "name": "value", - "required": false, + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "list by key", - "length": 255, - "name": "key", - "required": false, + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "list by customer name", - "length": 255, - "name": "customer", - "required": false, + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the domain associated with the tag", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the name of the domain to which the template belongs", "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, - {}, - {}, { - "description": "the ID of the domain associated with the tag", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the ID of the domain to which the template belongs", "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "tag key name", - "name": "key", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", "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": "the date this template was removed", + "name": "removed", + "type": "date" + }, { - "description": "any text associated with the success or failure", + "description": "the template display text", "name": "displaytext", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" - } - ] - }, - { - "description": "Get Kubernetes cluster config", - "isasync": false, - "name": "getKubernetesClusterConfig", - "params": [ - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + }, { - "description": "Name of the container cluster", - "name": "name", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, - {}, { - "description": "the id of the container cluster", - "name": "id", + "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 processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the config data of the cluster", - "name": "configdata", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" } - ] + ], + "since": "4.18.0" }, { - "description": "Create a virtual router element.", + "description": " delete a netscaler load balancer device", "isasync": true, - "name": "createVirtualRouterElement", + "name": "deleteNetscalerLoadBalancer", "params": [ { - "description": "The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter", - "length": 255, - "name": "providertype", - "related": "listNetworkServiceProviders", - "required": false, - "type": "uuid" - }, - { - "description": "the network service provider ID of the virtual router element", + "description": "netscaler load balancer device ID", "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", "required": true, "type": "uuid" } ], - "related": "configureVirtualRouterElement,listVirtualRouterElements", "response": [ {}, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "type": "string" - }, - { - "description": "the 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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID associated with the provider", - "name": "domainid", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the account associated with the provider", - "name": "account", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { - "description": "Creates a VPC", - "isasync": true, - "name": "createVPC", + "description": "Lists load balancer rules.", + "isasync": false, + "name": "listGlobalLoadBalancerRules", "params": [ { - "description": "an optional field, whether to the display the vpc to the end user or not", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "fordisplay", + "name": "tags", "required": false, - "since": "4.4", - "type": "boolean" + "type": "map" }, { - "description": "create VPC for the project", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "", "length": 255, - "name": "cidr", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "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": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the display text of the VPC", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "displaytext", - "required": true, - "type": "string" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the ID of the VPC offering", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", - "required": true, + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "required": false, "type": "uuid" }, { - "description": "the ID of the availability zone", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, "type": "uuid" }, { - "description": "VPC network domain. All networks inside the VPC will belong to this domain", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "networkdomain", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default.", + "description": "region ID", "length": 255, - "name": "start", + "name": "regionid", + "related": "addRegion,listRegions", "required": false, - "since": "4.3", - "type": "boolean" + "type": "integer" }, { - "description": "the account associated with the VPC. Must be used with the domainId parameter.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "the name of the VPC", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "listall", + "required": false, + "type": "boolean" } ], - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "related": "updateGlobalLoadBalancerRule", "response": [ { - "description": "the project id of the VPC", - "name": "projectid", + "description": "name of the global load balancer rule", + "name": "name", "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": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", + "type": "string" + }, + { + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, {}, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the description of the global load balancer rule", + "name": "description", + "type": "string" }, { - "description": "the list of supported services", - "name": "service", + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", "response": [ { - "description": "the list of capabilities", - "name": "capability", + "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 account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "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", + "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": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "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 domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the list of resource tags associated with load balancer", + "name": "tags", "response": [ { - "description": "the capability value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the capability name", - "name": "name", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ + }, { - "description": "the provider name", - "name": "name", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "tag key name", + "name": "key", + "type": "string" } ], "type": "list" }, { - "description": "the service name", + "description": "the name of the load balancer", "name": "name", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of resource tags associated with the project", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag 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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the private port", + "name": "privateport", "type": "string" }, - { - "description": "id of the resource", - "name": "resourceid", + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" } ], "type": "list" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", + "type": "string" }, + {} + ] + }, + { + "description": "Updates a disk offering.", + "isasync": false, + "name": "deleteDiskOffering", + "params": [ { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "ID of the disk offering", + "length": 255, + "name": "id", + "related": "createDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { @@ -61650,82 +66163,130 @@ "type": "integer" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {} + ] + }, + { + "description": "List resource tag(s)", + "isasync": false, + "name": "listTags", + "params": [ { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "list by resource type", + "length": 255, + "name": "resourcetype", + "required": false, "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "list by customer name", + "length": 255, + "name": "customer", + "required": false, "type": "string" }, { - "description": "the id of the VPC", - "name": "id", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "the network domain of the VPC", - "name": "networkdomain", - "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": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list by value", + "length": 255, + "name": "value", + "required": false, "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "list by resource id", + "length": 255, + "name": "resourceid", + "required": false, + "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "list by key", + "length": 255, + "name": "key", + "required": false, "type": "string" - } - ] - }, - { - "description": "Deletes a autoscale policy.", - "isasync": true, - "name": "deleteAutoScalePolicy", - "params": [ + }, { - "description": "the ID of the autoscale policy", + "description": "", "length": 255, - "name": "id", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], + "related": "", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + {}, + { + "description": "tag key name", + "name": "key", + "type": "string" }, {}, { @@ -61733,773 +66294,651 @@ "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" } - ] + ], + "since": "4.0.0" }, { - "description": "Deletes a role", - "isasync": false, - "name": "deleteRole", + "description": "Release the dedication for cluster", + "isasync": true, + "name": "releaseDedicatedCluster", "params": [ { - "description": "ID of the role", + "description": "the ID of the Cluster", "length": 255, - "name": "id", - "related": "createRole,importRole,listRoles,updateRole", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" } ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.9.0" + {} + ] }, { - "description": " delete a Cisco Nexus VSM device", - "isasync": true, - "name": "deleteCiscoNexusVSM", + "description": "Get Kubernetes cluster config", + "isasync": false, + "name": "getKubernetesClusterConfig", "params": [ { - "description": "Id of the Cisco Nexus 1000v VSM device to be deleted", + "description": "the ID of the Kubernetes cluster", "length": 255, "name": "id", - "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", - "required": true, + "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", + "required": false, "type": "uuid" } ], + "related": "", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the container cluster", + "name": "name", "type": "string" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the id of the container cluster", + "name": "id", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the config data of the cluster", + "name": "configdata", + "type": "string" + }, + {} ] }, { - "description": "List internal LB VMs.", - "isasync": false, - "name": "listInternalLoadBalancerVMs", + "description": "Create a virtual router element.", + "isasync": true, + "name": "createVirtualRouterElement", "params": [ { - "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", + "description": "The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter", "length": 255, - "name": "fetchhealthcheckresults", + "name": "providertype", + "related": "listNetworkServiceProviders", "required": false, - "since": "4.14", - "type": "boolean" + "type": "uuid" }, { - "description": "the state of the Internal LB VM", + "description": "the network service provider ID of the virtual router element", "length": 255, - "name": "state", - "required": false, + "name": "nspid", + "related": "listNetworkServiceProviders", + "required": true, + "type": "uuid" + } + ], + "related": "configureVirtualRouterElement,listVirtualRouterElements", + "response": [ + { + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the Pod ID of the Internal LB VM", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the ID of the Internal LB VM", - "length": 255, + "description": "the id of the router", "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,importUnmanagedInstance", - "required": false, - "type": "uuid" + "type": "string" }, + {}, { - "description": "the host ID of the Internal LB VM", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": false, - "type": "uuid" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the domain ID associated with the provider", + "name": "domainid", + "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 domain associated with the provider", + "name": "domain", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list by network id", + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + } + ] + }, + { + "description": "Creates a VPC", + "isasync": true, + "name": "createVPC", + "params": [ + { + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "publicmtu", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "integer" }, { - "description": "the Zone ID of the Internal LB VM", + "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "account", - "required": false, + "name": "cidr", + "required": true, "type": "string" }, { - "description": "", + "description": "create VPC for the project", "length": 255, - "name": "page", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "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": "keyword", + "name": "start", "required": false, - "type": "string" + "since": "4.3", + "type": "boolean" }, { - "description": "if true is passed for this parameter, list only VPC Internal LB VMs", + "description": "the first IPv6 DNS for the VPC", "length": 255, - "name": "forvpc", + "name": "ip6dns1", "required": false, - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "description": "List Internal LB VMs by VPC", + "description": "the ID of the VPC offering", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, + "name": "vpcofferingid", + "related": "updateVPCOffering", + "required": true, "type": "uuid" }, { - "description": "the name of the Internal LB VM", + "description": "VPC network domain. All networks inside the VPC will belong to this domain", "length": 255, - "name": "name", + "name": "networkdomain", "required": false, "type": "string" - } - ], - "related": "destroyRouter,listRouters", - "response": [ - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "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 host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the first IPv4 DNS for the VPC", + "length": 255, + "name": "dns1", + "required": false, + "since": "4.18.0", + "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the account associated with the router", + "description": "the account associated with the VPC. Must be used with the domainId parameter.", + "length": 255, "name": "account", + "required": false, "type": "string" }, { - "description": "the second DNS for the router", + "description": "the second IPv4 DNS for the VPC", + "length": 255, "name": "dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the second IPv6 DNS for the VPC", + "length": 255, + "name": "ip6dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the VPC", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the display text of the VPC", + "length": 255, + "name": "displaytext", + "required": true, "type": "string" - }, + } + ], + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "response": [ { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, + {}, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "the id of the router", - "name": "id", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the domain ID associated with the router", + "description": "the domain id of the VPC owner", "name": "domainid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", "type": "boolean" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, - {}, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "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 public netmask for the router", - "name": "publicnetmask", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "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": "the network domain for the router", - "name": "networkdomain", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "the list of supported services", + "name": "service", "response": [ { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "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 hostname for the router", - "name": "hostname", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + {}, + { + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the project", + "name": "tags", "response": [ { - "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": "macaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - } - ] - }, - { - "description": "Lists Cisco VNMC controllers", - "isasync": false, - "name": "listCiscoVnmcResources", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "Cisco VNMC resource ID", - "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "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 account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "list" + } ] }, { - "description": "Removes detail for the Resource.", + "description": "Deletes a autoscale policy.", "isasync": true, - "name": "removeResourceDetail", + "name": "deleteAutoScalePolicy", "params": [ { - "description": "Delete detail by resource type", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" - }, - { - "description": "Delete details matching key/value pairs", - "length": 255, - "name": "key", - "required": false, - "type": "string" - }, - { - "description": "Delete details for resource id", + "description": "the ID of the autoscale policy", "length": 255, - "name": "resourceid", + "name": "id", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ @@ -62508,89 +66947,8 @@ "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Lists all supported OS types for this cloud.", - "isasync": false, - "name": "listOsTypes", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list by Os Category id", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": false, - "type": "uuid" - }, - { - "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" - } - ], - "related": "addGuestOs", - "response": [ {}, - { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" - }, - { - "description": "the ID of the OS type", - "name": "id", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -62601,29 +66959,23 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "the ID of the OS category", - "name": "oscategoryid", - "type": "string" - }, { - "description": "the name/description of the OS type", - "name": "description", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] }, { - "description": "Deletes a particular egress rule from this security group", - "isasync": true, - "name": "revokeSecurityGroupEgress", + "description": "Deletes a role", + "isasync": false, + "name": "deleteRole", "params": [ { - "description": "The ID of the egress rule", + "description": "ID of the role", "length": 255, "name": "id", - "related": "authorizeSecurityGroupIngress", + "related": "createRole,importRole,listRoles,updateRole", "required": true, "type": "uuid" } @@ -62634,7 +66986,11 @@ "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", @@ -62646,40 +67002,32 @@ "type": "string" }, {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + {} ], - "since": "3.0.0" + "since": "4.9.0" }, { - "description": "Removes a Guest OS from listing.", + "description": " delete a Cisco Nexus VSM device", "isasync": true, - "name": "removeGuestOs", + "name": "deleteCiscoNexusVSM", "params": [ { - "description": "ID of the guest OS", + "description": "Id of the Cisco Nexus 1000v VSM device to be deleted", "length": 255, "name": "id", - "related": "addGuestOs", + "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "required": true, "type": "uuid" } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -62690,76 +67038,93 @@ "name": "displaytext", "type": "string" }, - {} - ], - "since": "4.4.0" + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] }, { - "description": "Uploads an icon for the specified resource(s)", + "description": "List internal LB VMs.", "isasync": false, - "name": "uploadResourceIcon", + "name": "listInternalLoadBalancerVMs", "params": [ { - "description": "type of the resource", + "description": "List Internal LB VMs by VPC", "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "list of resources to upload the icon/image for", + "description": "the ID of the Internal LB VM", "length": 255, - "name": "resourceids", - "required": true, - "type": "list" + "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,importUnmanagedInstance", + "required": false, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon/image", - "length": 2097152, - "name": "base64image", - "required": true, - "type": "string" - } - ], - "response": [ - {}, + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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", + "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.16.0.0" - }, - { - "description": "lists network that are using SRX firewall device", - "isasync": false, - "name": "listSrxFirewallNetworks", - "params": [ + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, { - "description": "netscaler load balancer device ID", + "description": "list by network id", "length": 255, - "name": "lbdeviceid", - "related": "configureSrxFirewall", - "required": true, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, "type": "uuid" }, + { + "description": "the name of the Internal LB VM", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "if true is passed for this parameter, list only VPC Internal LB VMs", + "length": 255, + "name": "forvpc", + "required": false, + "type": "boolean" + }, { "description": "", "length": 255, @@ -62768,11 +67133,20 @@ "type": "integer" }, { - "description": "", + "description": "the Pod ID of the Internal LB VM", "length": 255, - "name": "pagesize", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "the host ID of the Internal LB VM", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" }, { "description": "List by keyword", @@ -62780,454 +67154,677 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the Zone ID of the Internal LB VM", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the state of the Internal LB VM", + "length": 255, + "name": "state", + "required": false, + "type": "string" } ], - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "related": "destroyRouter,listRouters", "response": [ { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "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": "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the name of the router", + "name": "name", + "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, + {}, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + } + ], + "type": "list" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the first DNS for the network", - "name": "dns1", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the version of scripts", + "name": "scriptsversion", "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "list" + "description": "the account associated with the router", + "name": "account", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the project name of the address", + "name": "project", "type": "string" }, + {}, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the version of template", + "name": "version", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" - }, + } + ] + }, + { + "description": "Lists Cisco VNMC controllers", + "isasync": false, + "name": "listCiscoVnmcResources", + "params": [ { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "Cisco VNMC resource ID", + "length": 255, + "name": "resourceid", + "related": "listCiscoVnmcResources", + "required": false, + "type": "uuid" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "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 Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + {}, + {}, + {}, { - "description": "state of the network", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, + {}, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Removes detail for the Resource.", + "isasync": true, + "name": "removeResourceDetail", + "params": [ + { + "description": "Delete detail by resource type", + "length": 255, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "Delete details matching key/value pairs", + "length": 255, + "name": "key", + "required": false, "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "Delete details for resource id", + "length": 255, + "name": "resourceid", + "required": true, "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the network", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ] + }, + { + "description": "Lists all supported OS types for this cloud.", + "isasync": false, + "name": "listOsTypes", + "params": [ { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "list by Os Category id", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "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" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "list by Os type Id", + "length": 255, + "name": "id", + "related": "listOsTypes,addGuestOs", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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" + } + ], + "related": "addGuestOs", + "response": [ + { + "description": "the name/description of the OS type", + "name": "description", + "type": "string" + }, + { + "description": "is the guest OS user defined", + "name": "isuserdefined", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -63235,64 +67832,129 @@ }, {}, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the ID of the OS type", + "name": "id", "type": "string" }, + {}, { - "description": "the owner of the network", - "name": "account", + "description": "the ID of the OS category", + "name": "oscategoryid", "type": "string" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" } ] }, { - "description": "Update a supported Kubernetes version", - "isasync": false, - "name": "updateKubernetesSupportedVersion", + "description": "Deletes a particular egress rule from this security group", + "isasync": true, + "name": "revokeSecurityGroupEgress", "params": [ { - "description": "the enabled or disabled state of the Kubernetes supported version", + "description": "The ID of the egress rule", "length": 255, - "name": "state", + "name": "id", + "related": "authorizeSecurityGroupIngress", "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the Kubernetes supported version", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Removes a Guest OS from listing.", + "isasync": true, + "name": "removeGuestOs", + "params": [ + { + "description": "ID of the guest OS", "length": 255, "name": "id", - "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "related": "addGuestOs", "required": true, "type": "uuid" } ], - "related": "listKubernetesSupportedVersions", "response": [ + {}, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" + } + ], + "since": "4.4.0" + }, + { + "description": "Uploads an icon for the specified resource(s)", + "isasync": false, + "name": "uploadResourceIcon", + "params": [ + { + "description": "list of resources to upload the icon/image for", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" }, - {}, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "Base64 string representation of the resource icon/image", + "length": 2097152, + "name": "base64image", + "required": true, "type": "string" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -63300,25 +67962,57 @@ "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.16.0.0" + }, + { + "description": "Update a supported Kubernetes version", + "isasync": false, + "name": "updateKubernetesSupportedVersion", + "params": [ + { + "description": "the ID of the Kubernetes supported version", + "length": 255, + "name": "id", + "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": "whether Kubernetes supported version supports Autoscaling", "name": "supportsautoscaling", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { @@ -63326,24 +68020,24 @@ "name": "supportsha", "type": "boolean" }, + { + "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", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" - }, - { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { @@ -63351,10 +68045,42 @@ "name": "isostate", "type": "string" }, + { + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", + "type": "string" + }, + { + "description": "the id of the Kubernetes supported version", + "name": "id", + "type": "string" + }, { "description": "the name of the binaries ISO for Kubernetes supported version", "name": "isoname", "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" + }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", + "type": "string" } ] }, @@ -63382,44 +68108,195 @@ ], "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ - {}, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, { "description": "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", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "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": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + {}, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + {}, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -63428,63 +68305,48 @@ "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "Type of adapter if available", "name": "adaptertype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the nic", + "name": "id", "type": "string" }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { "description": "the IPv6 address of network", "name": "ip6address", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the netmask of the nic", + "name": "netmask", "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" }, { @@ -63493,328 +68355,330 @@ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the traffic type of the nic", + "name": "traffictype", "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 traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, { "description": "the cidr of IPv6 network", "name": "ip6cidr", "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" - } - ], - "type": "set" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ + }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" } ], "type": "set" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "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": "publicip", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the 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 target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, { "description": "the ID of the 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": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "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", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, { "description": "OS type id of the vm", "name": "ostypeid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the 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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "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 name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the 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 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 affinity group", + "name": "description", + "type": "string" + } + ], + "type": "set" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "Guest vm Boot Mode", + "name": "bootmode", "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" }, { @@ -63823,179 +68687,142 @@ "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 group name of the virtual machine", - "name": "group", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, { "description": "the project name of the group", "name": "project", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "id of the resource", + "name": "resourceid", "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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": "tag key name", + "name": "key", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "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 ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, + "description": "the 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": "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": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -64004,13 +68831,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -64019,13 +68846,23 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the protocol of the security group rule", "name": "protocol", @@ -64036,6 +68873,11 @@ "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", @@ -64047,111 +68889,128 @@ "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", + "description": "the type of the ICMP message response", + "name": "icmptype", "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" } ], "type": "set" }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, { "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the 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", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "tag value", - "name": "value", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", + "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" } ], "type": "set" @@ -64160,168 +69019,85 @@ "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 date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - {}, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - {}, { "description": "the ID of the disk offering of the virtual machine", "name": "diskofferingid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + {}, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the name of the affinity group", - "name": "name", - "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 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 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 project name of the affinity group", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { "description": "the ID of the backup offering of the virtual machine", @@ -64329,18 +69105,13 @@ "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" } ] @@ -64351,35 +69122,60 @@ "name": "createGuestNetworkIpv6Prefix", "params": [ { - "description": "UUID of zone to which the IPv6 prefix belongs to.", + "description": "The /56 or higher IPv6 CIDR for network prefix.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "prefix", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The /56 or higher IPv6 CIDR for network prefix.", + "description": "UUID of zone to which the IPv6 prefix belongs to.", "length": 255, - "name": "prefix", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listGuestNetworkIpv6Prefixes", "response": [ - {}, { "description": "count of the total IPv6 subnets for the prefix.", "name": "totalsubnets", "type": "integer" }, + { + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", + "type": "integer" + }, + { + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" + }, + { + "description": "guest IPv6 prefix", + "name": "prefix", + "type": "string" + }, + {}, + { + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "id of zone to which the IPv6 prefix belongs to.", "name": "zoneid", @@ -64389,111 +69185,187 @@ "description": "id of the guest IPv6 prefix", "name": "id", "type": "string" - }, + } + ], + "since": "4.17.0.0" + }, + { + "description": " delete a Palo Alto firewall device", + "isasync": true, + "name": "deletePaloAltoFirewall", + "params": [ { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", - "type": "integer" - }, + "description": "Palo Alto firewall device ID", + "length": 255, + "name": "fwdeviceid", + "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "guest IPv6 prefix", - "name": "prefix", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ] + }, + { + "description": "Deletes a Pod.", + "isasync": false, + "name": "deletePod", + "params": [ + { + "description": "the ID of the Pod", + "length": 255, + "name": "id", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" } ], - "since": "4.17.0.0" + "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": " delete a Palo Alto firewall device", - "isasync": true, - "name": "deletePaloAltoFirewall", + "description": "Lists Tungsten-Fabric providers", + "isasync": false, + "name": "listTungstenFabricProviders", "params": [ { - "description": "Palo Alto firewall device ID", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", - "required": true, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, "type": "uuid" } ], + "related": "", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", + "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" }, - {} - ] - }, - { - "description": "Deletes a Pod.", - "isasync": false, - "name": "deletePod", - "params": [ { - "description": "the ID of the Pod", - "length": 255, - "name": "id", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider name", + "name": "name", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", + "type": "string" }, - {} + { + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", + "type": "string" + } ] }, { @@ -64525,22 +69397,22 @@ ], "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -64549,6 +69421,14 @@ "isasync": false, "name": "createRole", "params": [ + { + "description": "ID of the role to be cloned from. Either roleid or type must be passed in", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": false, + "type": "uuid" + }, { "description": "The description of the role", "length": 255, @@ -64563,14 +69443,6 @@ "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": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, @@ -64581,17 +69453,11 @@ ], "related": "importRole,listRoles,updateRole", "response": [ - { - "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": "true if role is default, false otherwise", "name": "isdefault", @@ -64599,24 +69465,30 @@ }, {}, { - "description": "the ID of the role", - "name": "id", + "description": "the type of the role", + "name": "type", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "the type of the role", - "name": "type", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.9.0" @@ -64636,28 +69508,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": "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" - } + }, + {} ] }, { @@ -64669,187 +69541,118 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", "response": [ { - "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": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, + {}, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "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": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - {}, - {}, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { @@ -64858,18 +69661,23 @@ "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { @@ -64878,24 +69686,29 @@ "type": "long" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { "description": "the IP address of the host", @@ -64903,19 +69716,19 @@ "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 hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { "description": "comma-separated list of tags for the host", @@ -64923,119 +69736,183 @@ "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "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 host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "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": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "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 admin that annotated this host", - "name": "username", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "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 host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "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": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" + }, + { + "description": "events available for the host", + "name": "events", "type": "string" }, + { + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "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 amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -65053,22 +69930,22 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "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", @@ -65103,12 +69980,12 @@ "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -65117,10 +69994,18 @@ "name": "getUploadParamsForVolume", "params": [ { - "description": "an optional accountName. Must be used with domainId.", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, + "type": "uuid" + }, + { + "description": "the name of the volume/template", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { @@ -65131,19 +70016,19 @@ "type": "string" }, { - "description": "the name of the volume/template", + "description": "Upload volume/template for the project", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the ID of the zone the volume/template is to be hosted on", + "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "format", "required": true, - "type": "uuid" + "type": "string" }, { "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", @@ -65154,49 +70039,56 @@ "type": "uuid" }, { - "description": "Upload volume/template for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "Image store uuid", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "imagestoreuuid", + "name": "account", "required": false, "type": "string" }, { - "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", + "description": "the ID of the zone the volume/template 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 domainId. If the account parameter is used, domainId must also be used.", + "description": "Image store uuid", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "imagestoreuuid", "required": false, - "type": "uuid" + "type": "string" } ], "related": "getUploadParamsForTemplate,getUploadParamsForIso", "response": [ + {}, + { + "description": "the template/volume ID", + "name": "id", + "type": "uuid" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "signature to be sent in the POST request.", + "name": "signature", + "type": "string" + }, { "description": "encrypted data to be sent in the POST request.", "name": "metadata", "type": "string" }, + { + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" + }, { "description": "the timestamp after which the signature expires", "name": "expires", @@ -65207,21 +70099,6 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "signature to be sent in the POST request.", - "name": "signature", - "type": "string" - }, - { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" - }, - { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" } ], "since": "4.6.0" @@ -65232,27 +70109,27 @@ "name": "updateAutoScaleVmGroup", "params": [ { - "description": "an optional field, whether to the display the group to the end user or not", + "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": "list of scaledown autoscale policies", + "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": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "maxmembers", "required": false, - "type": "list" + "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.", + "description": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "minmembers", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { "description": "the ID of the autoscale group", @@ -65263,26 +70140,27 @@ "type": "uuid" }, { - "description": "the frequency at which the conditions have to be evaluated", + "description": "the frequency in which the performance counters to be collected", "length": 255, "name": "interval", "required": false, "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "list of scaledown autoscale policies", "length": 255, - "name": "customid", + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "since": "4.4", - "type": "string" + "type": "list" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "maxmembers", + "name": "customid", "required": false, - "type": "integer" + "since": "4.4", + "type": "string" }, { "description": "list of scaleup autoscale policies", @@ -65291,76 +70169,88 @@ "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, "type": "list" + }, + { + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "length": 255, + "name": "minmembers", + "required": false, + "type": "integer" } ], "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" }, + {}, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" + }, + { + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, {}, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the project id of the vm group", + "name": "projectid", "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 account owning the instance group", + "description": "the account owning the vm group", "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, - {}, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "the current state of the AutoScale Vm Group", + "name": "state", + "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the public port", + "name": "publicport", + "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.", @@ -65368,19 +70258,69 @@ "type": "int" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { "description": "the frequency at which the conditions have to be evaluated", "name": "interval", "type": "int" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the autoscale vm group ", + "name": "name", + "type": "string" + }, + { + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the domain name of the vm group", + "name": "domain", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -65390,12 +70330,11 @@ "name": "updateAutoScaleVmProfile", "params": [ { - "description": "the ID of the autoscale vm profile", + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", "length": 255, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" + "name": "counterparam", + "required": false, + "type": "map" }, { "description": "the ID of the user used to launch and destroy the VMs", @@ -65406,32 +70345,50 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the profile to the end user or not", + "description": "the service offering of the auto deployed virtual machine", "length": 255, - "name": "fordisplay", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.18.0", + "type": "uuid" }, { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "description": "an optional 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": "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": "counterparam", + "name": "otherdeployparams", "required": false, + "since": "4.18.0", "type": "map" }, { - "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 autoscale vm profile", "length": 255, - "name": "customid", + "name": "id", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, + "type": "uuid" + }, + { + "description": "an optional field, whether to the display the profile to the end user or not", + "length": 255, + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" }, { "description": "the time allowed for existing connections to get closed before a vm is destroyed", "length": 255, - "name": "destroyvmgraceperiod", + "name": "expungevmgraceperiod", "required": false, "type": "integer" }, @@ -65442,24 +70399,38 @@ "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, "type": "uuid" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" } ], "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", "response": [ + {}, { "description": "the availability zone to be used while deploying a virtual machine", "name": "zoneid", "type": "string" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { @@ -65467,30 +70438,31 @@ "name": "fordisplay", "type": "boolean" }, - { - "description": "the autoscale vm profile ID", - "name": "id", - "type": "string" - }, + {}, { "description": "the project name of the vm profile", "name": "project", "type": "string" }, + {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" + }, + { + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { @@ -65499,14 +70471,13 @@ "type": "string" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, - {}, { - "description": "the project id vm profile", - "name": "projectid", + "description": "Base 64 encoded VM user data", + "name": "userdata", "type": "string" }, { @@ -65515,15 +70486,14 @@ "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "destroyvmgraceperiod", - "type": "integer" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" } ] }, @@ -65544,70 +70514,120 @@ "related": "listAutoScaleVmGroups", "response": [ { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "the current 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 lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", + "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + }, + { + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the account owning the instance group", + "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 account owning the vm group", "name": "account", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the name of the autoscale vm group ", + "name": "name", "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 scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", + "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 maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", "type": "int" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" + }, + { + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the public ip address", + "name": "publicip", + "type": "string" }, { - "description": "the project id vm profile", + "description": "the date when this vm group was created", + "name": "created", + "type": "date" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the project id of the vm group", "name": "projectid", "type": "string" }, + { + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" + }, + { + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", + "type": "string" + }, + { + "description": "the domain name of the vm group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" + }, {}, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "list of scaledown autoscale policies", @@ -65615,21 +70635,26 @@ "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, - {}, { - "description": "the domain name of the vm profile", - "name": "domain", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - } + "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" + }, + {} ] }, { @@ -65647,124 +70672,29 @@ } ], "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": "Lists guest network IPv6 prefixes", - "isasync": false, - "name": "listGuestNetworkIpv6Prefixes", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "UUID of the IPv6 prefix.", - "length": 255, - "name": "id", - "related": "listGuestNetworkIpv6Prefixes", - "required": false, - "type": "uuid" - }, - { - "description": "UUID of zone to which the IPv6 prefix belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", - "type": "integer" - }, - { - "description": "id of the guest IPv6 prefix", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, - { - "description": "guest IPv6 prefix", - "name": "prefix", - "type": "string" - }, - { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "count of the 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": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } - ], - "since": "4.17.0" + ] }, { "description": "List the virtual machines owned by the account.", @@ -65772,17 +70702,16 @@ "name": "listVirtualMachines", "params": [ { - "description": "list by the backup offering", + "description": "list vms by iso", "length": 255, - "name": "backupofferingid", + "name": "isoid", "required": false, - "since": "4.17", "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": "the target hypervisor for the template", "length": 255, - "name": "state", + "name": "hypervisor", "required": false, "type": "string" }, @@ -65794,92 +70723,81 @@ "type": "integer" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "haenable", + "name": "ids", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "since": "4.15", - "type": "boolean" + "since": "4.4", + "type": "list" }, { - "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": "uuid" + "type": "string" }, { - "description": "the availability zone 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": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "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" }, { - "description": "list vms by iso", + "description": "list vms by template", "length": 255, - "name": "isoid", + "name": "templateid", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, "type": "uuid" }, { - "description": "list by the service offering", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "the target hypervisor for the template", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "hypervisor", + "name": "displayvm", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the cluster ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.16.0", "type": "uuid" }, { - "description": "list vms by ssh keypair name", - "length": 255, - "name": "keypair", - "required": false, - "type": "string" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "showicon", "required": false, - "type": "uuid" + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "the security group 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": "securitygroupid", - "related": "createSecurityGroup", + "name": "listall", "required": false, - "since": "4.15", - "type": "uuid" + "type": "boolean" }, { "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", @@ -65897,31 +70815,17 @@ "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "displayvm", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", + "description": "the availability zone ID", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "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 by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "listall", + "name": "forvirtualnetwork", "required": false, "type": "boolean" }, @@ -65934,51 +70838,58 @@ "type": "uuid" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", "length": 255, - "name": "accumulate", + "name": "userdata", "required": false, - "since": "4.17.0", + "since": "4.18.0.0", "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "flag to display the resource icon for VMs", + "description": "the pod ID", "length": 255, - "name": "showicon", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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": "isrecursive", + "name": "details", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "list by the service offering", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "ids", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.4", - "type": "list" + "type": "uuid" + }, + { + "description": "list vms by ssh keypair name", + "length": 255, + "name": "keypair", + "required": false, + "type": "string" }, { "description": "the group ID", @@ -65997,32 +70908,18 @@ "type": "uuid" }, { - "description": "list vms by vpc", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" - }, - { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "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": "forvirtualnetwork", + "name": "accumulate", "required": false, + "since": "4.17.0", "type": "boolean" }, { - "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", - "length": 255, - "name": "details", - "required": false, - "type": "list" - }, - { - "description": "the pod ID", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" }, @@ -66030,180 +70927,117 @@ "description": "the host ID", "length": 255, "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "list vms by template", + "description": "the security group ID", "length": 255, - "name": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "securitygroupid", + "related": "createSecurityGroup", "required": false, + "since": "4.15", "type": "uuid" }, { - "description": "", + "description": "list by the backup offering", "length": 255, - "name": "page", + "name": "backupofferingid", "required": false, - "type": "integer" - } - ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "response": [ - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "since": "4.17", + "type": "uuid" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "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", - "type": "string" + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "since": "4.16.0", + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "the ID of AutoScaling VM Group", + "length": 255, + "name": "autoscalevmgroupid", + "related": "listAutoScaleVmGroups", + "required": false, + "since": "4.18.0", + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list vms by vpc", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + } + ], + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, - {}, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "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 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { "description": "the VM's disk write in KiB", @@ -66211,28 +71045,23 @@ "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "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 user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -66240,68 +71069,158 @@ "name": "pooltype", "type": "string" }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, { "description": "State of the Service from LB rule", "name": "servicestate", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, { "description": "the project id of the vm", "name": "projectid", "type": "string" }, + { + "description": "the 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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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 NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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": "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -66310,146 +71229,116 @@ "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the 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": "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 extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the netmask of the nic", + "name": "netmask", + "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" } ], "type": "set" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - {}, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, + {}, { - "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": "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 name of the affinity group", - "name": "name", - "type": "string" - }, { "description": "the ID of the affinity group", "name": "id", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { @@ -66458,14 +71347,14 @@ "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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the description of the affinity group", + "name": "description", + "type": "string" }, { "description": "the domain ID of the affinity group", @@ -66473,46 +71362,91 @@ "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "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 name of the affinity group", + "name": "name", + "type": "string" } ], "type": "set" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the name of the virtual machine", + "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 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 name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "name": "publicipid", "type": "string" }, { @@ -66521,62 +71455,191 @@ "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "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": "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 ISO attached to the virtual machine", - "name": "isoname", + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + {}, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "name": "publicip", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "Guest vm Boot Type", + "name": "boottype", + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { "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 list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { "description": "the CIDR notation for the base IP address of the security group rule", @@ -66584,8 +71647,18 @@ "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -66603,61 +71676,56 @@ "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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": "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" } ], "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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -66666,92 +71734,65 @@ "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 starting IP of the security group rule", + "name": "startport", "type": "integer" } ], "type": "set" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "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 egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "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": "tag value", - "name": "value", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "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": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -66759,8 +71800,8 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -66784,84 +71825,111 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the 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 account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { @@ -66869,195 +71937,276 @@ "name": "account", "type": "string" }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, { "description": "the domain name of the security group", "name": "domain", "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" } ], "type": "set" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, { "description": "the write (IO) of disk on the VM", "name": "diskiowrite", "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine", - "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", + "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "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": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + } + ] + }, + { + "description": "Lists guest network IPv6 prefixes", + "isasync": false, + "name": "listGuestNetworkIpv6Prefixes", + "params": [ + { + "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": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "UUID of the IPv6 prefix.", + "length": 255, "name": "id", + "related": "listGuestNetworkIpv6Prefixes", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", + "type": "integer" + }, + {}, + { + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "guest IPv6 prefix", + "name": "prefix", + "type": "string" + }, + {}, + { + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" + }, + { + "description": "id of the guest IPv6 prefix", + "name": "id", "type": "string" + } + ], + "since": "4.17.0" + }, + { + "description": "Updates the information about Guest OS to Hypervisor specific name mapping", + "isasync": true, + "name": "updateGuestOsMapping", + "params": [ + { + "description": "UUID of the Guest OS to hypervisor name Mapping", + "length": 255, + "name": "id", + "related": "updateGuestOsMapping", + "required": true, + "type": "uuid" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Hypervisor specific name for this Guest OS", + "length": 255, + "name": "osnameforhypervisor", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the Guest OS type", + "name": "ostypeid", + "type": "string" }, + {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" }, {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the ID of the Guest OS mapping", + "name": "id", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "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": "is the mapping user defined", + "name": "isuserdefined", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" } - ] + ], + "since": "4.4.0" }, { - "description": "Updates the information about Guest OS to Hypervisor specific name mapping", + "description": "delete Tungsten-Fabric tag", "isasync": true, - "name": "updateGuestOsMapping", + "name": "deleteTungstenFabricTag", "params": [ { - "description": "Hypervisor specific name for this Guest OS", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "osnameforhypervisor", + "name": "taguuid", "required": true, "type": "string" }, { - "description": "UUID of the Guest OS to hypervisor name Mapping", + "description": "the ID of zone", "length": 255, - "name": "id", - "related": "updateGuestOsMapping", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" } ], - "related": "", "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { @@ -67066,27 +72215,11 @@ "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the ID of the Guest OS type", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the ID of the Guest OS mapping", - "name": "id", - "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" } - ], - "since": "4.4.0" + ] }, { "description": "Lists all available disk offerings.", @@ -67094,11 +72227,11 @@ "name": "listDiskOfferings", "params": [ { - "description": "name of the disk offering", + "description": "", "length": 255, - "name": "name", + "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.", @@ -67108,12 +72241,19 @@ "type": "boolean" }, { - "description": "ID of the disk offering", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "id", - "related": "createDiskOffering,listDiskOfferings", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" + }, + { + "description": "listed offerings support disk encryption", + "length": 255, + "name": "encrypt", + "required": false, + "since": "4.18", + "type": "boolean" }, { "description": "List by keyword", @@ -67123,17 +72263,18 @@ "type": "string" }, { - "description": "", + "description": "ID of the disk offering", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createDiskOffering,listDiskOfferings", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "The ID of the volume, tags of the volume are used to filter the offerings", + "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, "since": "4.17", "type": "uuid" @@ -67148,77 +72289,83 @@ "type": "uuid" }, { - "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 volume, tags of the volume are used to filter the offerings", "length": 255, - "name": "listall", + "name": "volumeid", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "boolean" + "since": "4.17", + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "name of the disk offering", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", + "description": "", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "page", "required": false, - "since": "4.17", - "type": "uuid" + "type": "integer" } ], "related": "createDiskOffering", "response": [ { - "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 min iops of the disk offering", - "name": "miniops", + "description": "the size of the disk offering in GB", + "name": "disksize", "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "unique ID of the disk offering", - "name": "id", + "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" }, { @@ -67227,18 +72374,23 @@ "type": "string" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, { "description": "the storage type for this disk offering", "name": "storagetype", "type": "string" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { @@ -67246,60 +72398,61 @@ "name": "hasannotations", "type": "boolean" }, - { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" - }, - { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" - }, + {}, { "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "name": "provisioningtype", "type": "string" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, { "description": "bytes write rate of the disk offering", "name": "diskBytesWriteRate", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "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 date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the tags for the disk offering", + "name": "tags", + "type": "string" }, { "description": "io requests write rate of the disk offering", @@ -67307,61 +72460,59 @@ "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, - {}, { "description": "burst io requests write rate of the disk offering", "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "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", + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", "type": "boolean" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" - }, - { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { "description": "an alternate display text of the disk offering.", "name": "displaytext", "type": "string" }, - {}, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", "type": "boolean" + }, + { + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" } ] }, @@ -67378,20 +72529,19 @@ "type": "string" }, { - "description": "the cluster ID", + "description": "the host ID", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "the host ID", + "description": "if the password should also be updated on the hosts", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "name": "update_passwd_on_host", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "the new password for the host/cluster", @@ -67401,20 +72551,26 @@ "type": "string" }, { - "description": "if the password should also be updated on the hosts", + "description": "the cluster ID", "length": 255, - "name": "update_passwd_on_host", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "boolean" + "type": "uuid" } ], "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -67425,12 +72581,7 @@ "name": "displaytext", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -67439,75 +72590,71 @@ "name": "createPortableIpRange", "params": [ { - "description": "the gateway for the portable IP range", + "description": "the beginning IP address in the portable IP range", "length": 255, - "name": "gateway", + "name": "startip", "required": true, "type": "string" }, { - "description": "Id of the Region", + "description": "the netmask of the portable IP range", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "netmask", "required": true, - "type": "integer" + "type": "string" }, { - "description": "the beginning IP address in the portable IP range", + "description": "the ending IP address in the portable IP range", "length": 255, - "name": "startip", + "name": "endip", "required": true, "type": "string" }, { - "description": "VLAN id, if not specified defaulted to untagged", + "description": "the gateway for the portable IP range", "length": 255, - "name": "vlan", - "required": false, + "name": "gateway", + "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 netmask of the portable IP range", + "description": "VLAN id, if not specified defaulted to untagged", "length": 255, - "name": "netmask", - "required": true, + "name": "vlan", + "required": false, "type": "string" } ], "related": "", "response": [ { - "description": "the start ip of the portable IP range", - "name": "startip", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "portable IP range ID", + "name": "id", "type": "string" }, { - "description": "portable IP range ID", - "name": "id", + "description": "the end ip of the portable IP range", + "name": "endip", "type": "string" }, { @@ -67515,78 +72662,82 @@ "name": "regionid", "type": "integer" }, - { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", "name": "portableipaddress", "response": [ { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", - "type": "string" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "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: Allocatin, Allocated and Releasing", - "name": "state", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the account ID the portable IP address is associated with", + "name": "accountid", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", "type": "string" } ], "type": "list" }, { - "description": "the end ip of the portable IP range", - "name": "endip", + "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 start ip of the portable IP range", + "name": "startip", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.2.0" @@ -67596,6 +72747,35 @@ "isasync": false, "name": "updateCluster", "params": [ + { + "description": "the ID of the Cluster", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + }, + { + "description": "hypervisor type of the cluster", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "hypervisor type of the cluster", + "length": 255, + "name": "clustertype", + "required": false, + "type": "string" + }, + { + "description": "the cluster name", + "length": 255, + "name": "clustername", + "required": false, + "type": "string" + }, { "description": "whether this cluster is managed by cloudstack", "length": 255, @@ -67604,44 +72784,56 @@ "type": "string" }, { - "description": "hypervisor type of the cluster", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "hypervisor", + "name": "allocationstate", "required": false, "type": "string" + } + ], + "related": "addCluster", + "response": [ + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + }, + {}, + { + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the cluster ID", + "name": "id", + "type": "string" }, { - "description": "hypervisor type of the cluster", - "length": 255, - "name": "clustertype", - "required": false, + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { "description": "the cluster name", - "length": 255, - "name": "clustername", - "required": false, + "name": "name", "type": "string" }, { - "description": "the ID of the Cluster", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" - } - ], - "related": "addCluster", - "response": [ + }, { "description": "the Zone name of the cluster", "name": "zonename", @@ -67653,13 +72845,18 @@ "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { @@ -67672,9 +72869,9 @@ "name": "capacity", "response": [ { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { "description": "the capacity name", @@ -67682,13 +72879,13 @@ "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Pod ID", + "name": "podid", + "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { @@ -67696,19 +72893,29 @@ "name": "podname", "type": "string" }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "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 Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { @@ -67717,37 +72924,21 @@ "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" } ], "type": "list" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, - {}, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, {}, @@ -67755,46 +72946,6 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the cluster ID", - "name": "id", - "type": "string" - }, - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", - "type": "string" } ] }, @@ -67813,18 +72964,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" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -67834,7 +72978,14 @@ "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" + }, + {} ] }, { @@ -67862,43 +73013,60 @@ "related": "createKubernetesCluster,startKubernetesCluster", "response": [ { - "description": "Maximum size of the cluster", - "name": "maxsize", + "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 network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, + {}, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, + {}, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { @@ -67907,81 +73075,74 @@ "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" }, - {}, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, - {}, { "description": "Minimum size of the cluster", "name": "minsize", "type": "long" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { "description": "the name of the zone of the Kubernetes cluster", @@ -67989,23 +73150,28 @@ "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "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": "zoneid", + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "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", + "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -68014,18 +73180,8 @@ "type": "boolean" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" - }, - { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "type": "string" - }, - { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { @@ -68034,14 +73190,9 @@ "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -68051,16 +73202,16 @@ "name": "listStorageProviders", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -68072,23 +73223,18 @@ "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the type of the storage provider: primary or image provider", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -68096,13 +73242,18 @@ "name": "name", "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" - } + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ] }, { @@ -68110,6 +73261,13 @@ "isasync": false, "name": "listUcsProfiles", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "the id for the ucs manager", "length": 255, @@ -68121,7 +73279,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -68131,33 +73289,26 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "", "response": [ - {}, { "description": "ucs profile dn", "name": "ucsdn", "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" + }, + {}, {} ] }, @@ -68177,18 +73328,18 @@ ], "related": "registerUserKeys", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "the api key of the registered user", "name": "apikey", "type": "string" }, {}, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the secret key of the registered user", "name": "secretkey", @@ -68208,24 +73359,16 @@ "name": "updateGlobalLoadBalancerRule", "params": [ { - "description": "the ID of the global load balancer rule", - "length": 255, - "name": "id", - "related": "updateGlobalLoadBalancerRule", - "required": true, - "type": "uuid" - }, - { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "description": "load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", "length": 255, - "name": "gslbstickysessionmethodname", + "name": "gslblbmethod", "required": false, "type": "string" }, { - "description": "load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", + "description": "session sticky method (sourceip) if not specified defaults to sourceip", "length": 255, - "name": "gslblbmethod", + "name": "gslbstickysessionmethodname", "required": false, "type": "string" }, @@ -68235,107 +73378,124 @@ "name": "description", "required": false, "type": "string" + }, + { + "description": "the ID of the global load balancer rule", + "length": 255, + "name": "id", + "related": "updateGlobalLoadBalancerRule", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, { "description": "DNS domain name given for the global load balancer", "name": "gslbdomainname", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, { "description": "the account of the load balancer rule", "name": "account", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "GSLB service type", - "name": "gslbservicetype", - "type": "string" - }, - {}, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "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 domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the global load balancer rule", - "name": "description", - "type": "string" - }, - { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", - "type": "string" - }, { "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, { "description": "the 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 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 project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "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" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -68344,13 +73504,13 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -68359,155 +73519,139 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" } ], "type": "list" }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "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 account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "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 id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the public port", - "name": "publicport", + "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", + "type": "string" + }, + { + "description": "global load balancer rule ID", + "name": "id", + "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 domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", + "type": "string" + }, + { + "description": "name of the global load balancer rule", + "name": "name", + "type": "string" + }, { "description": "Region Id in which global load balancer is created", "name": "regionid", "type": "integer" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ] }, { - "description": "Creates a condition", + "description": "Creates a condition for VM auto scaling", "isasync": true, "name": "createCondition", "params": [ { - "description": "Threshold value.", + "description": "the account of the condition. Must be used with the domainId parameter.", "length": 255, - "name": "threshold", - "required": true, - "type": "long" + "name": "account", + "required": false, + "type": "string" }, { - "description": "Relational Operator to be used with threshold.", + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", "length": 255, "name": "relationaloperator", "required": true, "type": "string" }, - { - "description": "the account of the condition. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "ID of the Counter.", "length": 255, @@ -68523,18 +73667,28 @@ "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" + }, + { + "description": "Value for which the Counter will be evaluated with the Operator selected.", + "length": 255, + "name": "threshold", + "required": true, + "type": "long" + }, + { + "description": "an optional project for condition", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "zone id of counter", - "name": "zoneid", - "type": "string" - }, - { - "description": "the id of the Condition", - "name": "id", + "description": "the Id of the Counter.", + "name": "counterid", "type": "string" }, { @@ -68542,16 +73696,6 @@ "name": "projectid", "type": "string" }, - { - "description": "the owner of the Condition.", - "name": "account", - "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", @@ -68562,20 +73706,25 @@ "name": "jobid", "type": "string" }, - {}, + { + "description": "the owner of the Condition.", + "name": "account", + "type": "string" + }, { "description": "Threshold Value for the counter.", "name": "threshold", "type": "long" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, + {}, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, { @@ -68583,11 +73732,31 @@ "name": "domainid", "type": "string" }, + { + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", + "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 Condition", + "name": "id", + "type": "string" + }, { "description": "Details of the Counter.", "name": "counter", - "type": "list" + "type": "counterresponse" } ] }, @@ -68597,45 +73766,51 @@ "name": "listProjects", "params": [ { - "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": "flag to display the resource icon for projects", "length": 255, - "name": "account", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "details", + "name": "isrecursive", "required": false, - "type": "list" + "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "keyword", + "name": "details", "required": false, - "type": "string" + "type": "list" + }, + { + "description": "List projects by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -68647,19 +73822,18 @@ "type": "string" }, { - "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 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 projects by username", @@ -68669,112 +73843,96 @@ "type": "string" }, { - "description": "flag to display the resource icon for projects", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list projects by state", "length": 255, - "name": "listall", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List projects 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 projects by display text", + "description": "list projects by project ID", "length": 255, - "name": "displaytext", + "name": "id", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" } ], "related": "listProjectAccounts,activateProject,suspendProject,updateProject", "response": [ { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "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 number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, - {}, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "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) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { @@ -68783,8 +73941,13 @@ "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { @@ -68793,108 +73956,129 @@ "type": "integer" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total 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 total volume available for this project", - "name": "volumeavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "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", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, - { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" - }, { "description": "the total number of cpu cores the project can own", "name": "cpulimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "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 domain name where the project belongs to", + "name": "domain", + "type": "string" }, + {}, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -68903,101 +74087,86 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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" } ], "type": "list" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "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", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "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", + "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" } ], @@ -69009,193 +74178,121 @@ "name": "createAccount", "params": [ { - "description": "details for account used to store specific parameters", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "accountdetails", + "name": "userid", "required": false, - "type": "map" + "type": "string" }, { - "description": "Creates the account under the specified role.", + "description": "Account UUID, required for adding account from external provisioning system", "length": 255, - "name": "roleid", - "related": "importRole,listRoles,updateRole", + "name": "accountid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Network domain for the account's networks", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "networkdomain", + "name": "timezone", "required": false, "type": "string" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "details for account used to store specific parameters", "length": 255, - "name": "accounttype", + "name": "accountdetails", "required": false, - "type": "integer" + "type": "map" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "description": "email", "length": 255, - "name": "password", + "name": "email", "required": true, "type": "string" }, { - "description": "Creates the user under the specified domain.", + "description": "Unique username.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "name": "username", + "required": true, + "type": "string" }, { - "description": "Unique username.", + "description": "firstname", "length": 255, - "name": "username", + "name": "firstname", "required": true, "type": "string" }, { - "description": "Account UUID, required for adding account from external provisioning system", + "description": "lastname", "length": 255, - "name": "accountid", - "required": false, + "name": "lastname", + "required": true, "type": "string" }, { - "description": "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.", + "description": "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": "User UUID, required for adding account from external provisioning system", + "description": "Creates the account under the specified role.", "length": 255, - "name": "userid", + "name": "roleid", + "related": "importRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "email", + "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": "email", - "required": true, + "name": "account", + "required": false, "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": "firstname", + "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": "firstname", + "name": "password", "required": true, "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "timezone", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" } ], "related": "enableAccount,listAccounts,listAccounts", "response": [ { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - {}, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "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 number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" - }, - { - "description": "the name of the account", - "name": "name", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - {}, - { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { @@ -69203,149 +74300,89 @@ "name": "domain", "type": "string" }, - { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, { "description": "true if account is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "the total number of virtual machines 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 secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the state of the account", - "name": "state", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, { "description": "the boolean value representing if the updating target is in caller's child domain", "name": "iscallerchilddomain", "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the user firstname", + "name": "firstname", "type": "string" }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, { "description": "the domain name of the user", "name": "domain", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the timezone user was created in", + "name": "timezone", "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 user firstname", - "name": "firstname", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "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", @@ -69358,13 +74395,18 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", "type": "string" }, { @@ -69373,8 +74415,18 @@ "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "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", "type": "string" }, { @@ -69383,152 +74435,279 @@ "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the user ID", - "name": "id", + "description": "the domain ID of the user", + "name": "domainid", "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 ID of the role", + "name": "roleid", + "type": "string" } ], "type": "list" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "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": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, { "description": "the date when this account was created", "name": "created", "type": "date" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" }, + {}, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "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", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "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", + "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "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", + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "type": "integer" }, { "description": "the total number of public ip addresses allocated for this account", "name": "iptotal", "type": "long" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" } ] }, @@ -69548,50 +74727,55 @@ ], "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ + {}, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the 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 name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -69600,271 +74784,47 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "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": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "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 vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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 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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the type of the nic", + "description": "the type of the affinity group", "name": "type", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { @@ -69873,8 +74833,8 @@ "type": "list" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { @@ -69883,111 +74843,71 @@ "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { "description": "the description of the affinity group", "name": "description", "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" } ], "type": "set" }, { - "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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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": "State of the Service from LB rule", - "name": "servicestate", + "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": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "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": "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 backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "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 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 resource tags associated with the rule", @@ -69999,23 +74919,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "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" }, { @@ -70024,74 +74939,84 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "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 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" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "the description of the security group", + "name": "description", "type": "string" }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the 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 starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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" }, { @@ -70100,13 +75025,13 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -70114,87 +75039,47 @@ "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", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "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", + "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 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" } ], "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 description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, { "description": "the ID of the security group", "name": "id", @@ -70210,18 +75095,18 @@ "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -70230,22 +75115,32 @@ "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "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" }, { @@ -70253,6 +75148,11 @@ "name": "project", "type": "string" }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", @@ -70263,30 +75163,20 @@ "name": "projectid", "type": "string" }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { "description": "id of the resource", "name": "resourceid", "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" } ], "type": "set" @@ -70297,106 +75187,283 @@ "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" } ], "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "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 ID of 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", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the 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 vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "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 account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, - {}, { "description": "List of read-only Vm details as comma separated string.", "name": "readonlydetails", "type": "string" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "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": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the 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": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, + {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "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", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { @@ -70405,23 +75472,28 @@ "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { @@ -70430,84 +75502,236 @@ "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the project id of the vm", + "name": "projectid", "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 total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "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 vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "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 ID of the nic", + "name": "id", + "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" } ], "since": "4.2.0" @@ -70552,21 +75776,21 @@ "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 host tag", "name": "name", "type": "string" }, - {}, { "description": "the host ID of the host tag", "name": "hostid", "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -70582,6 +75806,14 @@ "required": true, "type": "map" }, + { + "description": "ID of Guest OS category", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories", + "required": true, + "type": "uuid" + }, { "description": "Optional name for Guest OS", "length": 255, @@ -70595,48 +75827,40 @@ "name": "osdisplayname", "required": true, "type": "string" - }, - { - "description": "ID of Guest OS category", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": true, - "type": "uuid" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, {}, { - "description": "the ID of the OS category", - "name": "oscategoryid", - "type": "string" + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" }, { - "description": "the name/description of the OS type", - "name": "description", + "description": "the ID of the OS type", + "name": "id", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" + "description": "the name/description of the OS type", + "name": "description", + "type": "string" }, { - "description": "the ID of the OS type", - "name": "id", + "description": "the ID of the OS category", + "name": "oscategoryid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -70647,6 +75871,13 @@ "isasync": false, "name": "addAnnotation", "params": [ + { + "description": "the entity type (only HOST is allowed atm)", + "length": 255, + "name": "entitytype", + "required": false, + "type": "string" + }, { "description": "the annotation is visible for admins only", "length": 255, @@ -70668,25 +75899,18 @@ "name": "entityid", "required": false, "type": "string" - }, - { - "description": "the entity type (only HOST is allowed atm)", - "length": 255, - "name": "entitytype", - "required": false, - "type": "string" } ], "related": "removeAnnotation,updateAnnotationVisibility", "response": [ { - "description": "the (uu)id of the entitiy to which this annotation pertains", - "name": "entityid", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { @@ -70694,29 +75918,36 @@ "name": "id", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the creation timestamp for this annotation", "name": "created", "type": "date" }, { - "description": "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 (uu)id of the user that entered the annotation", - "name": "userid", + "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": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, + {}, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { @@ -70725,21 +75956,14 @@ "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, - {}, { - "description": "the name of the entitiy to which this annotation pertains", - "name": "entityname", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" - }, - {}, - { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" } ], "since": "4.11" @@ -70759,30 +75983,123 @@ } ], "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" }, - {}, + {} + ], + "since": "4.4.0" + }, + { + "description": "create Tungsten-Fabric service group", + "isasync": true, + "name": "createTungstenFabricServiceGroup", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Tungsten-Fabric service group protocol", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric service group end port", + "length": 255, + "name": "endport", + "required": true, + "type": "integer" + }, + { + "description": "Tungsten-Fabric service group start port", + "length": 255, + "name": "startport", + "required": true, + "type": "integer" + }, + { + "description": "Tungsten-Fabric service group name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric service group 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", + "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": "Tungsten-Fabric service group uuid", + "name": "uuid", "type": "string" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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 service group start port", + "name": "startport", + "type": "int" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric service group end port", + "name": "endport", + "type": "int" } - ], - "since": "4.4.0" + ] }, { "description": "Registers an existing ISO into the CloudStack Cloud.", @@ -70790,16 +76107,23 @@ "name": "registerIso", "params": [ { - "description": "the name of the ISO", - "length": 255, - "name": "name", + "description": "the display text of the ISO. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", "required": true, "type": "string" }, { - "description": "Image store UUID", + "description": "true if you want this ISO to be featured", "length": 255, - "name": "imagestoreuuid", + "name": "isfeatured", + "required": false, + "type": "boolean" + }, + { + "description": "an optional account name. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, "type": "string" }, @@ -70812,38 +76136,37 @@ "type": "uuid" }, { - "description": "an optional account name. Must be used with domainId.", + "description": "true if password reset feature is supported; default is false", "length": 255, - "name": "account", + "name": "passwordenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if password reset feature is supported; default is false", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "passwordenabled", + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "directdownload", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the display text of the ISO. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", + "description": "the name of the ISO", + "length": 255, + "name": "name", "required": true, "type": "string" }, { - "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "directdownload", + "name": "ispublic", "required": false, "type": "boolean" }, @@ -70855,18 +76178,26 @@ "type": "boolean" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "bootable", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "true if you want this ISO to be featured", + "description": "Image store UUID", "length": 255, - "name": "isfeatured", + "name": "imagestoreuuid", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "length": 255, + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" }, { "description": "the ID of the zone you wish to register the ISO to.", @@ -70876,6 +76207,14 @@ "required": true, "type": "uuid" }, + { + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, { "description": "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, @@ -70889,35 +76228,34 @@ "name": "url", "required": true, "type": "string" + } + ], + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "response": [ + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", - "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, + {}, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", - "length": 255, - "name": "ispublic", - "required": false, + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" - } - ], - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "response": [ + }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { @@ -70926,50 +76264,49 @@ "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "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": "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, - {}, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "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 ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { "description": "additional key/value details tied with template", @@ -70977,48 +76314,28 @@ "type": "map" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "the template name", - "name": "name", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { @@ -71027,24 +76344,24 @@ "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", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { "description": "the template display text", @@ -71052,142 +76369,142 @@ "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the 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": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "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", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, + {}, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the type of the template", - "name": "templatetype", - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { "description": "the ID of the secondary storage host for the template", @@ -71195,9 +76512,24 @@ "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the date this template was removed", + "name": "removed", + "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 template ID", @@ -71205,19 +76537,24 @@ "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "the project name of the template", + "name": "project", + "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": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" } ] }, @@ -71227,11 +76564,12 @@ "name": "listCiscoAsa1000vResources", "params": [ { - "description": "", + "description": "Cisco ASA 1000v resource ID", "length": 255, - "name": "page", + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", @@ -71241,17 +76579,23 @@ "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", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -71262,25 +76606,12 @@ "related": "createPhysicalNetwork", "required": false, "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "addCiscoAsa1000vResource", "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", @@ -71289,7 +76620,13 @@ }, {}, {}, - {} + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -71297,6 +76634,14 @@ "isasync": true, "name": "deployNetscalerVpx", "params": [ + { + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" + }, { "description": "the ID of the service offering for the virtual machine", "length": 255, @@ -71313,14 +76658,6 @@ "required": true, "type": "uuid" }, - { - "description": "the ID of the template for the virtual machine", - "length": 255, - "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" - }, { "description": "The network this ip address should be associated to.", "length": 255, @@ -71333,49 +76670,34 @@ "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter", "response": [ { - "description": "device name", - "name": "lbdevicename", - "type": "string" - }, - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "device state", - "name": "lbdevicestate", - "type": "string" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "name of the provider", - "name": "provider", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "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": "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 physical network to which this netscaler device belongs to", @@ -71383,10 +76705,20 @@ "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", "type": "boolean" }, + { + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -71394,28 +76726,33 @@ "type": "string" }, { - "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", + "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "device name", + "name": "lbdevicename", + "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "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", + "name": "provider", "type": "string" }, {} @@ -71437,34 +76774,30 @@ "related": "", "response": [ { - "description": "the name of the volume", - "name": "name", - "type": "string" - }, - { - "description": "compression", - "name": "compression", + "description": "graceallowed", + "name": "graceallowed", "type": "string" }, { - "description": "deduplication", - "name": "deduplication", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the id of the volume", - "name": "id", + "description": "syncronization", + "name": "sync", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the volume", + "name": "name", "type": "string" }, { - "description": "syncronization", - "name": "sync", + "description": "deduplication", + "name": "deduplication", "type": "string" }, { @@ -71472,10 +76805,14 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "graceallowed", - "name": "graceallowed", + "description": "compression", + "name": "compression", + "type": "string" + }, + { + "description": "the id of the volume", + "name": "id", "type": "string" } ] @@ -71495,27 +76832,27 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -71532,58 +76869,72 @@ "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "URL of the external pxe device", "length": 255, - "name": "password", + "name": "url", "required": true, "type": "string" }, { - "description": "Pod Id", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "name": "username", + "required": true, + "type": "string" }, { - "description": "type of pxe device", + "description": "the Physical Network ID", "length": 255, - "name": "pxeservertype", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Credentials to reach external pxe device", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "URL of the external pxe device", + "description": "type of pxe device", "length": 255, - "name": "url", + "name": "pxeservertype", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "Pod Id", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, "type": "uuid" } ], "related": "", "response": [ - {}, { "description": "name of the provider", "name": "provider", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "url", + "name": "url", + "type": "string" + }, { "description": "the physical network to which this external dhcp device belongs to", "name": "physicalnetworkid", @@ -71600,21 +76951,7 @@ "type": "string" }, {}, - { - "description": "url", - "name": "url", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -71622,13 +76959,6 @@ "isasync": false, "name": "listNiciraNvpDevices", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -71637,12 +76967,11 @@ "type": "integer" }, { - "description": "nicira nvp device ID", + "description": "", "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the Physical Network ID", @@ -71653,29 +76982,42 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "nicira nvp device ID", + "length": 255, + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "required": false, + "type": "uuid" } ], "related": "addNiciraNvpDevice", "response": [ { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", + "type": "string" + }, + { + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, - {}, { "description": "this L3 gateway service Uuid", "name": "l3gatewayserviceuuid", "type": "string" }, + {}, { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "niciradevicename", "type": "string" }, { @@ -71688,32 +77030,27 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "device name", - "name": "niciradevicename", - "type": "string" - }, { "description": "the controller Ip address", "name": "hostname", "type": "string" }, { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" }, - {}, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -71721,13 +77058,6 @@ "isasync": false, "name": "listAlerts", "params": [ - { - "description": "list by alert type", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -71736,10 +77066,11 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "list by alert name", "length": 255, - "name": "keyword", + "name": "name", "required": false, + "since": "4.3", "type": "string" }, { @@ -71750,6 +77081,13 @@ "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -71758,21 +77096,15 @@ "type": "integer" }, { - "description": "list by alert name", + "description": "list by alert type", "length": 255, - "name": "name", + "name": "type", "required": false, - "since": "4.3", "type": "string" } ], "related": "", "response": [ - { - "description": "the date and time the alert was sent", - "name": "sent", - "type": "date" - }, { "description": "description of the alert", "name": "description", @@ -71783,27 +77115,32 @@ "name": "name", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", "name": "type", "type": "short" }, - {}, { - "description": "the current status of the latest async job acting 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 alert", "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date and time the alert was sent", + "name": "sent", + "type": "date" } ] }, @@ -71813,51 +77150,87 @@ "name": "deployVirtualMachine", "params": [ { - "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": "Controls specific policies on IO", "length": 255, - "name": "boottype", + "name": "iodriverpolicy", "required": false, - "since": "4.14.0.0", "type": "string" }, { - "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": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", "required": false, - "since": "4.13", "type": "uuid" }, { - "description": "the ipv6 address for default vm's network", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "ip6address", + "name": "keypair", "required": false, "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": "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": "iptonetworklist", + "name": "diskofferingid", + "related": "createDiskOffering", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "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": "affinitygroupnames", - "related": "", + "name": "bootmode", "required": false, - "type": "list" + "since": "4.14.0.0", + "type": "string" + }, + { + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "length": 255, + "name": "copyimagetags", + "required": false, + "since": "4.13", + "type": "boolean" + }, + { + "description": "the mac address for default vm's network", + "length": 255, + "name": "macaddress", + "required": false, + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" + }, + { + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "length": 255, + "name": "keyboard", + "required": false, + "type": "string" }, { "description": "an optional user generated name for the virtual machine", @@ -71867,25 +77240,23 @@ "type": "string" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "an optional group for the virtual machine", "length": 255, - "name": "keypairs", + "name": "group", "required": false, - "since": "4.17", - "type": "list" + "type": "string" }, { - "description": "used to specify the vApp properties.", + "description": "the ipv6 address for default vm's network", "length": 255, - "name": "properties", + "name": "ip6address", "required": false, - "since": "4.15", - "type": "map" + "type": "string" }, { - "description": "the mac address for default vm's network", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "macaddress", + "name": "account", "required": false, "type": "string" }, @@ -71898,43 +77269,66 @@ "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": "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": "diskofferingid", + "name": "overridediskofferingid", "related": "createDiskOffering", "required": false, + "since": "4.17", "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": "long" + }, + { + "description": "the ip address for default vm's network", + "length": 255, + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "length": 255, + "name": "datadiskofferinglist", "required": false, - "since": "4.12", + "since": "4.11", + "type": "map" + }, + { + "description": "true if start vm after creating; defaulted to true if not specified", + "length": 255, + "name": "startvm", + "required": false, + "type": "boolean" + }, + { + "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "length": 255, + "name": "boottype", + "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", "length": 255, - "name": "affinitygroupids", + "name": "affinitygroupnames", "related": "", "required": false, "type": "list" }, { - "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "datadiskofferinglist", + "name": "deploymentplanner", "required": false, - "since": "4.11", - "type": "map" + "since": "4.4", + "type": "string" }, { "description": "Deploy vm for the project", @@ -71944,6 +77338,23 @@ "required": false, "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", + "required": false, + "type": "list" + }, + { + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": false, + "since": "4.13", + "type": "uuid" + }, { "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, @@ -71953,47 +77364,111 @@ "type": "boolean" }, { - "description": "the ip address for default vm's network", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "ipaddress", + "name": "customid", "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 ID of the service offering for the virtual machine", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "true if virtual machine needs to be dynamically scalable", + "length": 255, + "name": "dynamicscalingenabled", + "required": false, + "since": "4.16", + "type": "boolean" + }, + { + "description": "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": "an optional account for the virtual machine. Must be used with domainId.", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "account", + "name": "details", + "required": false, + "since": "4.3", + "type": "map" + }, + { + "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "the ID of the Userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18", + "type": "uuid" + }, + { + "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": "names of the ssh key pairs used to login to the virtual machine", + "length": 255, + "name": "keypairs", + "required": false, + "since": "4.17", + "type": "list" + }, + { + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.", + "length": 1048576, + "name": "userdata", "required": false, "type": "string" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "length": 255, + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "list" + }, + { + "description": "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": "startvm", + "name": "dhcpoptionsnetworklist", "required": false, - "type": "boolean" + "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": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "rootdisksize", + "name": "displayvm", "required": false, - "since": "4.4", - "type": "long" + "since": "4.2", + "type": "boolean" }, { - "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "nicnetworklist", + "name": "userdatadetails", "required": false, - "since": "4.15", + "since": "4.18", "type": "map" }, { @@ -72005,18 +77480,19 @@ "type": "uuid" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "description": "used to specify the vApp properties.", "length": 255, - "name": "copyimagetags", + "name": "properties", "required": false, - "since": "4.13", - "type": "boolean" + "since": "4.15", + "type": "map" }, { - "description": "name of the ssh key pair used to login to the virtual machine", - "length": 255, - "name": "keypair", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", "required": false, + "since": "4.12", "type": "string" }, { @@ -72027,159 +77503,148 @@ "type": "string" }, { - "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": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "keyboard", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "since": "4.13", + "type": "uuid" }, { - "description": "an optional group for the virtual machine", + "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": "group", + "name": "nicnetworklist", "required": false, - "type": "string" + "since": "4.15", + "type": "map" }, { - "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": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "name": "affinitygroupids", + "related": "", + "required": false, + "type": "list" + } + ], + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", - "length": 255, - "name": "overridediskofferingid", - "related": "createDiskOffering", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", - "length": 255, - "name": "details", - "required": false, - "since": "4.3", - "type": "map" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", - "length": 255, - "name": "displayvm", - "required": false, - "since": "4.2", - "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": "destination Host ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", - "required": false, - "type": "uuid" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + {}, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", - "length": 255, - "name": "deploymentplanner", - "required": false, - "since": "4.4", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", - "length": 255, - "name": "size", - "required": false, - "type": "long" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the ID of the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", - "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", - "required": false, - "type": "list" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "since": "4.13", - "type": "uuid" + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" }, { - "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable", - "length": 255, - "name": "dynamicscalingenabled", - "required": false, - "since": "4.16", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", - "length": 255, - "name": "bootmode", - "required": false, - "since": "4.14.0.0", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" - } - ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "response": [ + }, { - "description": "the 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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + {}, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { @@ -72187,49 +77652,39 @@ "name": "securitygroup", "response": [ { - "description": "the project id of the group", - "name": "projectid", + "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 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 list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -72239,6 +77694,16 @@ "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 name where tag belongs to", "name": "project", @@ -72249,14 +77714,19 @@ "name": "value", "type": "string" }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -72268,75 +77738,75 @@ "description": "the account associated with the tag", "name": "account", "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" } ], "type": "set" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "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 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", + "description": "the code for the ICMP message response", + "name": "icmpcode", "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" }, { @@ -72345,8 +77815,8 @@ "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -72359,13 +77829,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -72379,18 +77844,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the 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" }, { @@ -72402,18 +77867,18 @@ "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 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 ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -72425,6 +77890,11 @@ "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" @@ -72435,32 +77905,32 @@ "type": "integer" }, { - "description": "the project name of the group", - "name": "project", + "description": "the description of the security group", + "name": "description", "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 list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the project id of the group", + "name": "projectid", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -72469,18 +77939,18 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -72489,171 +77959,69 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the 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" } ], "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" } ], "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "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": "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 ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the 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": "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", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { @@ -72662,212 +78030,170 @@ "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 name of the virtual machine", - "name": "name", + "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", - "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "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": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "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 account associated with the virtual machine", - "name": "account", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the 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 project name of the vm", - "name": "project", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "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", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, - {}, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "Guest vm Boot Type", + "name": "boottype", "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": "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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 amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of 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": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { "description": "the user's ID who deployed the virtual machine", @@ -72875,13 +78201,28 @@ "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": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "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 account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -72889,13 +78230,43 @@ "name": "nic", "response": [ { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -72903,20 +78274,65 @@ "name": "nsxlogicalswitchport", "type": "string" }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, { "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { "description": "the Secondary ipv4 addr of nic", @@ -72924,203 +78340,200 @@ "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ID of the nic", + "name": "id", "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 VLAN/VNI if available", - "name": "vlanid", + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project name of the affinity group", + "name": "project", "type": "string" - }, + } + ], + "type": "set" + }, + { + "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "tag key name", + "name": "key", + "type": "string" } ], "type": "set" }, - {}, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "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", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "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": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - {}, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" } ] @@ -73138,14 +78551,6 @@ "required": false, "type": "uuid" }, - { - "description": "upgrades all routers within the specified cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" - }, { "description": "upgrades all routers owned by the specified account", "length": 255, @@ -73153,14 +78558,6 @@ "required": false, "type": "string" }, - { - "description": "upgrades all routers within the specified zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "upgrades all routers within the specified pod", "length": 255, @@ -73176,22 +78573,38 @@ "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" + }, + { + "description": "upgrades all routers within the specified cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": false, + "type": "uuid" + }, + { + "description": "upgrades all routers within the specified zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" } ], "related": "", "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -73203,204 +78616,118 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], - "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", "response": [ { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "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 amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" - }, { "description": "the CPU number of the host", "name": "cpunumber", "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - {}, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the name of the host", - "name": "name", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { "description": "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", @@ -73411,130 +78738,231 @@ "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { - "description": "Maximum 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": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "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 amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the cluster name of the host", + "name": "clustername", + "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 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": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, { "description": "the hypervisor version", "name": "hypervisorversion", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, + {}, + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the ID of the host", + "name": "id", + "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 date and time the host was removed", "name": "removed", "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", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the IP address of the host", + "name": "ipaddress", "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 this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, { "description": "the total disk size of the host", "name": "disksizetotal", "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "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": "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": "events available for the host", + "name": "events", + "type": "string" }, { "description": "the number of CPU sockets on the host", @@ -73542,33 +78970,23 @@ "type": "integer" }, { - "description": "the ID of the host", - "name": "id", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" } ] @@ -73579,55 +78997,32 @@ "name": "listVlanIpRanges", "params": [ { - "description": "network id of the VLAN IP range", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "project who will own the VLAN", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the Pod ID of the VLAN IP range", + "description": "physical network id of the VLAN IP range", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "true if VLAN is of Virtual type, false if Direct", - "length": 255, - "name": "forvirtualnetwork", - "required": false, - "type": "boolean" - }, - { - "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", "length": 255, - "name": "vlan", + "name": "account", "required": false, "type": "string" }, { - "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "physical network id of the VLAN IP range", + "description": "the Pod ID of the VLAN IP range", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, @@ -73639,6 +79034,13 @@ "required": false, "type": "uuid" }, + { + "description": "true if VLAN is of Virtual type, false if Direct", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" + }, { "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, @@ -73650,7 +79052,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -73663,11 +79065,27 @@ "type": "uuid" }, { - "description": "", + "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", "length": 255, - "name": "page", + "name": "vlan", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "network id of the VLAN IP range", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { "description": "List by keyword", @@ -73680,33 +79098,33 @@ "related": "updateVlanIpRange,dedicatePublicIpRange", "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, - { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" - }, { "description": "the end ipv6 of the VLAN IP range", "name": "endipv6", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { @@ -73715,68 +79133,70 @@ "type": "integer" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", - "type": "string" - }, - { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, + {}, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, + {}, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { @@ -73784,33 +79204,31 @@ "name": "domain", "type": "string" }, - {}, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" - }, - {} + } ] }, { @@ -73819,39 +79237,40 @@ "name": "updateZone", "params": [ { - "description": "the second DNS for the Zone", + "description": "the dns search order list", "length": 255, - "name": "dns2", + "name": "dnssearchorder", "required": false, - "type": "string" + "type": "list" }, { - "description": "the name of the Zone", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "name", + "name": "ip6dns1", "required": false, "type": "string" }, { - "description": "the guest CIDR address for the Zone", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "guestcidraddress", + "name": "internaldns1", "required": false, "type": "string" }, { - "description": "updates a private zone to public if set, but not vice-versa", + "description": "the ID of the Zone", "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "name": "id", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "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": "true if local storage offering enabled, false otherwise", @@ -73868,68 +79287,67 @@ "type": "string" }, { - "description": "the ID of the Zone", + "description": "updates a private zone to public if set, but not vice-versa", "length": 255, - "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "ispublic", + "required": false, + "type": "boolean" }, { - "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": "the second internal DNS for the Zone", + "description": "the dhcp Provider for the Zone", "length": 255, - "name": "internaldns2", + "name": "dhcpprovider", "required": false, "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "the name of the Zone", "length": 255, - "name": "internaldns1", + "name": "name", "required": false, "type": "string" }, { - "description": "the dhcp Provider for the Zone", + "description": "the second DNS for the Zone", "length": 255, - "name": "dhcpprovider", + "name": "dns2", "required": false, "type": "string" }, { - "description": "the dns search order list", + "description": "sort key of the zone, integer", "length": 255, - "name": "dnssearchorder", + "name": "sortkey", "required": false, - "type": "list" + "type": "integer" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "allocationstate", + "name": "internaldns2", "required": false, "type": "string" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "ip6dns1", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the details for the Zone", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "details", + "name": "guestcidraddress", "required": false, - "type": "map" + "type": "string" }, { "description": "the second DNS for IPv6 network in the Zone", @@ -73942,49 +79360,91 @@ "related": "createZone,listZones,listZones", "response": [ { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the display text of the zone", - "name": "displaytext", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" + "description": "the list of resource tags associated with zone.", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "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 first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { "description": "Zone id", @@ -73992,8 +79452,8 @@ "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { @@ -74001,61 +79461,96 @@ "name": "ip6dns2", "type": "string" }, + {}, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the network type of the zone; can be Basic or Advanced", "name": "networktype", "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + { + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", "type": "boolean" }, { - "description": "Zone description", - "name": "description", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "Zone name", + "name": "name", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" }, { "description": "the capacity of the Zone", @@ -74067,131 +79562,74 @@ "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Pod ID", + "name": "podid", + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in use", + "name": "capacityused", "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 capacity name", + "name": "name", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" } ], "type": "list" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, - {}, { - "description": "Zone name", - "name": "name", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, - { - "description": "the list of resource tags associated with zone.", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project 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": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - } + {} ] }, { @@ -74200,11 +79638,12 @@ "name": "extractVolume", "params": [ { - "description": "the url to which the volume would be extracted", - "length": 2048, - "name": "url", - "required": false, - "type": "string" + "description": "the ID of the zone where the volume is located", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { "description": "the ID of the volume", @@ -74215,36 +79654,30 @@ "type": "uuid" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", - "length": 255, - "name": "mode", - "required": true, + "description": "the url to which the volume would be extracted", + "length": 2048, + "name": "url", + "required": false, "type": "string" }, { - "description": "the ID of the zone where the volume is located", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "mode", "required": true, - "type": "uuid" + "type": "string" } ], "related": "extractTemplate", "response": [ { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { @@ -74252,29 +79685,41 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "the state of the extracted object", "name": "state", "type": "string" }, - { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, { "description": "", "name": "resultstring", "type": "string" }, + {}, { - "description": "the id of extracted object", - "name": "id", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, + { + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the id of extracted object", + "name": "id", "type": "string" }, { @@ -74283,36 +79728,29 @@ "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" }, - {}, - {}, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { "description": "the account id to which the extracted object belongs", "name": "accountid", "type": "string" - }, - { - "description": "zone ID the object was extracted from", - "name": "zoneid", - "type": "string" } ] }, @@ -74322,19 +79760,18 @@ "name": "listProjectAccounts", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list accounts of the project by project role id", + "description": "", "length": 255, - "name": "projectroleid", - "related": "updateProjectRole", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "ID of the project", @@ -74345,9 +79782,16 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list accounts of the project by account name", + "length": 255, + "name": "account", "required": false, "type": "string" }, @@ -74360,95 +79804,37 @@ "type": "uuid" }, { - "description": "list accounts of the project by role", + "description": "list accounts of the project by project role id", "length": 255, - "name": "role", + "name": "projectroleid", + "related": "updateProjectRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list accounts of the project by account name", + "description": "list accounts of the project by role", "length": 255, - "name": "account", + "name": "role", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "activateProject,suspendProject,updateProject", "response": [ { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "list" + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the id of the project", + "name": "id", + "type": "string" }, { "description": "the total number of templates which have been created by this project", @@ -74456,13 +79842,13 @@ "type": "long" }, { - "description": "the state of the project", - "name": "state", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { @@ -74471,74 +79857,74 @@ "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "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 snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, - { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, { "description": "the total number of templates available to be created by this project", "name": "templateavailable", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -74546,33 +79932,106 @@ "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" + }, + { + "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", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, + {}, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { @@ -74581,59 +80040,58 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, - {}, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "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 total number of networks available to be created for this project", "name": "networkavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, + { + "description": "the state of the project", + "name": "state", + "type": "string" + }, { "description": "the total volume being used by this project", "name": "volumetotal", "type": "long" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { @@ -74641,40 +80099,20 @@ "name": "templatelimit", "type": "string" }, - { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" - }, - {}, - { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "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 public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" } ], @@ -74685,20 +80123,6 @@ "isasync": true, "name": "updateAutoScalePolicy", "params": [ - { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "length": 255, - "name": "quiettime", - "required": false, - "type": "integer" - }, - { - "description": "the duration for which the conditions have to be true before action is taken", - "length": 255, - "name": "duration", - "required": false, - "type": "integer" - }, { "description": "the ID of the autoscale policy", "length": 255, @@ -74714,18 +80138,50 @@ "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 cool down period in which the policy should not be evaluated after the action has been taken", + "length": 255, + "name": "quiettime", + "required": false, + "type": "integer" + }, + { + "description": "the duration in which the conditions have to be true before action is taken", + "length": 255, + "name": "duration", + "required": false, + "type": "integer" } ], "related": "listAutoScalePolicies", "response": [ + { + "description": "the account owning the autoscale policy", + "name": "account", + "type": "string" + }, + { + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" + }, { "description": "the project name of the autoscale policy", "name": "project", "type": "string" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { @@ -74733,52 +80189,47 @@ "name": "jobid", "type": "string" }, - {}, { - "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 domain name of the autoscale policy", "name": "domain", "type": "string" }, + { + "description": "the autoscale policy ID", + "name": "id", + "type": "string" + }, {}, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, { - "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 duration for which the conditions have to be true before action is taken", "name": "duration", "type": "integer" }, { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the autoscale policy ID", - "name": "id", - "type": "string" - }, - { - "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -74788,82 +80239,84 @@ "name": "createDiskOffering", "params": [ { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "cachemode", "required": false, - "type": "list" + "since": "4.14", + "type": "string" }, { - "description": "io requests write rate of the disk offering", - "length": 255, - "name": "iopswriterate", - "required": false, - "type": "long" + "description": "alternate display text of the disk offering", + "length": 4096, + "name": "displaytext", + "required": true, + "type": "string" }, { - "description": "bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadrate", + "description": "tags for the disk offering", + "length": 4096, + "name": "tags", "required": false, - "type": "long" + "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "iopsreadratemaxlength", + "name": "displayoffering", "required": false, - "type": "long" + "type": "boolean" }, { - "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": "tags for the disk offering", - "length": 4096, - "name": "tags", + "description": "whether disk offering iops is custom or not", + "length": 255, + "name": "customizediops", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "cachemode", + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", "required": false, - "since": "4.14", - "type": "string" + "since": "4.15", + "type": "uuid" }, { "description": "length (in seconds) of the burst", "length": 255, - "name": "bytesreadratemaxlength", + "name": "iopswriteratemaxlength", "required": false, "type": "long" }, { - "description": "min iops of the disk offering", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "miniops", + "name": "iopsreadrate", "required": false, "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "max iops of the disk offering", "length": 255, - "name": "iopswriteratemaxlength", + "name": "maxiops", "required": false, "type": "long" }, { - "description": "whether disk offering size is custom or not", + "description": "Volumes using this offering should be encrypted", "length": 255, - "name": "customized", + "name": "encrypt", "required": false, + "since": "4.18", "type": "boolean" }, { @@ -74874,77 +80327,91 @@ "type": "long" }, { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "length (in seconds) of the burst", "length": 255, - "name": "displayoffering", + "name": "byteswriteratemaxlength", "required": false, - "type": "boolean" + "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": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", + "name": "iopswriterate", "required": false, - "since": "4.15", - "type": "uuid" + "type": "long" }, { - "description": "burst bytes 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": "byteswriteratemax", + "name": "hypervisorsnapshotreserve", + "required": false, + "type": "integer" + }, + { + "description": "burst requests read rate of the disk offering", + "length": 255, + "name": "iopsreadratemax", "required": false, "type": "long" }, { - "description": "the storage type of the disk offering. Values are local and shared.", + "description": "length (in seconds) of the burst", "length": 255, - "name": "storagetype", + "name": "bytesreadratemaxlength", "required": false, - "type": "string" + "type": "long" }, { - "description": "alternate display text of the disk offering", - "length": 4096, - "name": "displaytext", - "required": true, - "type": "string" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "length": 255, + "name": "disksizestrictness", + "required": false, + "since": "4.17", + "type": "boolean" }, { - "description": "max iops of the disk offering", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "maxiops", + "name": "byteswriteratemax", "required": false, "type": "long" }, { - "description": "burst bytes read rate of the disk offering", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "bytesreadratemax", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "long" + "type": "list" }, { - "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": "iopsreadratemaxlength", "required": false, "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", + "description": "details to specify disk offering parameters", "length": 255, - "name": "disksizestrictness", + "name": "details", "required": false, - "since": "4.17", - "type": "boolean" + "since": "4.16", + "type": "map" + }, + { + "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", + "length": 255, + "name": "disksize", + "required": false, + "type": "long" }, { "description": "the ID of the containing zone(s), null for public offerings", @@ -74956,16 +80423,9 @@ "type": "list" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "byteswriteratemaxlength", - "required": false, - "type": "long" - }, - { - "description": "burst requests read rate of the disk offering", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "iopsreadratemax", + "name": "bytesreadrate", "required": false, "type": "long" }, @@ -74977,31 +80437,30 @@ "type": "string" }, { - "description": "details to specify disk offering parameters", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "details", + "name": "provisioningtype", "required": false, - "since": "4.16", - "type": "map" + "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "min iops of the disk offering", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "miniops", "required": false, - "type": "integer" + "type": "long" }, { - "description": "io requests read rate of the disk offering", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "iopsreadrate", + "name": "byteswriterate", "required": false, "type": "long" }, { - "description": "bytes write rate of the disk offering", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "byteswriterate", + "name": "bytesreadratemax", "required": false, "type": "long" } @@ -75009,48 +80468,63 @@ "related": "", "response": [ { - "description": "the storage type for this disk offering", - "name": "storagetype", - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the storage type for this disk offering", + "name": "storagetype", + "type": "string" + }, + { + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" + }, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", "type": "long" }, { @@ -75059,74 +80533,79 @@ "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "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", - "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 tags for the disk offering", - "name": "tags", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "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": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" }, + {}, { "description": "the date this disk offering was created", "name": "created", "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, - {}, { - "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 ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { @@ -75135,61 +80614,51 @@ "type": "string" }, { - "description": "the name of the disk offering", - "name": "name", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", - "type": "string" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "the size of the disk offering in GB", + "name": "disksize", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the disk offering", + "name": "name", "type": "string" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "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": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - { - "description": "unique ID of the disk offering", - "name": "id", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, - {}, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" - } + }, + {} ] }, { @@ -75198,42 +80667,56 @@ "name": "listVolumes", "params": [ { - "description": "list volumes on specified host", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "displayvolume", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the ID of the disk volume", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "state", "required": false, - "type": "uuid" + "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": "activateProject,suspendProject,updateProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "the pod id the disk volume belongs to", + "length": 255, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { "description": "the IDs of the volumes, mutually exclusive with id", @@ -75244,14 +80727,6 @@ "since": "4.9", "type": "list" }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, { "description": "the cluster id the disk volume belongs to", "length": 255, @@ -75261,33 +80736,42 @@ "type": "uuid" }, { - "description": "the pod id the disk volume belongs to", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "uuid" + "since": "4.3", + "type": "string" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "state", + "name": "listsystemvms", "required": false, - "type": "string" + "since": "4.18", + "type": "boolean" }, { - "description": "the ID of the availability zone", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, "type": "uuid" }, @@ -75299,175 +80783,215 @@ "type": "string" }, { - "description": "list volumes by disk offering", + "description": "", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "uuid" + "type": "integer" }, { - "description": "the name of the disk volume", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "displayvolume", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "the type of disk volume", "length": 255, - "name": "page", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "list volumes by disk offering", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "diskofferingid", + "related": "", "required": false, - "since": "4.3", - "type": "string" + "since": "4.4", + "type": "uuid" }, { - "description": "", + "description": "list volumes on specified host", "length": 255, - "name": "pagesize", + "name": "hostid", + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the type of disk volume", + "description": "the name of the disk volume", "length": 255, - "name": "type", + "name": "name", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the virtual machine", "length": 255, - "name": "isrecursive", + "name": "virtualmachineid", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "attachVolume,createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the path of the volume", - "name": "path", + "description": "cluster id of the volume", + "name": "clusterid", "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 date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "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": "min iops of the disk volume", + "name": "miniops", + "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 ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { "description": "the write (IO) of disk on the vm", @@ -75475,34 +80999,39 @@ "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { "description": "bytes read rate of the disk volume", @@ -75510,8 +81039,13 @@ "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { @@ -75520,187 +81054,135 @@ "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "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": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "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": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the account associated with the disk volume", + "name": "account", "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", - "type": "long" + "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": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "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": "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": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "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 ID of 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 vpn", - "name": "project", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { @@ -75709,54 +81191,54 @@ "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", + "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", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "pod id of the volume", + "name": "podid", + "type": "string" } ] }, @@ -75774,71 +81256,82 @@ "type": "uuid" }, { - "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", + "description": "HTTP ping path", "length": 255, - "name": "responsetimeout", + "name": "pingpath", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the description of the load balancer health check policy", + "description": "Number of consecutive health check success before declaring an instance healthy", "length": 255, - "name": "description", + "name": "healthythreshold", "required": false, - "type": "string" + "type": "integer" }, { - "description": "HTTP ping path", + "description": "Number of consecutive health check failures before declaring an instance unhealthy", "length": 255, - "name": "pingpath", + "name": "unhealthythreshold", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", + "description": "Amount of time between health checks (1 sec - 20940 sec)", "length": 255, - "name": "healthythreshold", + "name": "intervaltime", "required": false, "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the description of the load balancer health check policy", "length": 255, - "name": "fordisplay", + "name": "description", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy", + "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", "length": 255, - "name": "unhealthythreshold", + "name": "responsetimeout", "required": false, "type": "integer" }, { - "description": "Amount of time between health checks (1 sec - 20940 sec)", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "intervaltime", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" } ], "related": "listLBHealthCheckPolicies", "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", + "type": "string" + }, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ { - "description": "the state of the policy", - "name": "state", - "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", + "name": "healthcheckthresshold", + "type": "int" }, { "description": "Amount of time between health checks", @@ -75846,9 +81339,9 @@ "type": "int" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" }, { "description": "the pingpath of the healthcheck policy", @@ -75856,36 +81349,36 @@ "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": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" }, { "description": "the description of the healthcheck policy", "name": "description", "type": "string" + }, + { + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, {}, @@ -75895,26 +81388,15 @@ "type": "string" }, { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", - "type": "string" - }, - { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.2.0" }, @@ -75935,75 +81417,90 @@ "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", "response": [ { - "description": "the user name", - "name": "username", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, - {}, { "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 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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the secret key of the user", "name": "secretkey", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { "description": "the timezone user was created in", @@ -76011,34 +81508,33 @@ "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "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", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "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": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user name", + "name": "username", "type": "string" }, { @@ -76047,15 +81543,11 @@ "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user ID", + "name": "id", "type": "string" }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - } + {} ] }, { @@ -76066,27 +81558,27 @@ "related": "", "response": [ { - "description": "the Cloudian connector enabled state", - "name": "enabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the Cloudian Management Console base URL", "name": "url", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting 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 Cloudian connector enabled state", + "name": "enabled", + "type": "boolean" + }, + {}, + {} ], "since": "4.11.0" }, @@ -76095,13 +81587,6 @@ "isasync": false, "name": "listLBHealthCheckPolicies", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the ID of the health check policy", "length": 255, @@ -76111,6 +81596,13 @@ "since": "4.4", "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "List by keyword", "length": 255, @@ -76137,22 +81629,59 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "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 UUID of the latest async job acting on 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 healthcheckpolicies", "name": "healthcheckpolicy", "response": [ + { + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" + }, + { + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" + }, + { + "description": "the description of the healthcheck policy", + "name": "description", + "type": "string" + }, { "description": "the state of the policy", "name": "state", @@ -76163,75 +81692,38 @@ "name": "healthcheckinterval", "type": "int" }, + { + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" + }, { "description": "the LB HealthCheck policy ID", "name": "id", "type": "string" }, - { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" - }, { "description": "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", "name": "pingpath", "type": "string" - }, - { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" - }, - { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" } ], "type": "list" }, { - "description": "the LB rule ID", - "name": "lbruleid", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", "type": "string" }, { "description": "the id of the zone the HealthCheck policy belongs to", "name": "zoneid", "type": "string" - }, - {}, - { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", - "type": "string" } ], "since": "4.2.0" @@ -76242,75 +81734,130 @@ "name": "createNetwork", "params": [ { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "IPV4 address to be assigned to a router in a shared network", "length": 255, - "name": "ip6cidr", + "name": "routerip", "required": false, + "since": "4.16", "type": "string" }, { - "description": "the network offering ID", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", + "name": "startipv6", + "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", + "length": 255, + "name": "subdomainaccess", + "required": false, + "type": "boolean" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "length": 255, + "name": "tungstenvirtualrouteruuid", + "required": false, + "type": "string" + }, + { + "description": "Network ACL ID associated for the network", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList", + "required": false, + "type": "uuid" + }, + { + "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 ID or VID of the network", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" + }, + { + "description": "the zone ID for the network", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "IPV6 address to be assigned to a router in a shared network", + "description": "the physical network ID the network belongs to", "length": 255, - "name": "routeripv6", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "since": "4.16", - "type": "string" + "type": "uuid" }, { - "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", + "description": "the first IPv6 DNS for the network", "length": 255, - "name": "bypassvlanoverlapcheck", + "name": "ip6dns1", "required": false, - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "startipv6", + "name": "publicmtu", "required": false, - "type": "string" + "since": "4.18.0", + "type": "integer" }, { - "description": "the display text of the network", + "description": "the isolated private VLAN type for this network", "length": 255, - "name": "displaytext", - "required": true, + "name": "isolatedpvlantype", + "required": false, "type": "string" }, { - "description": "the zone ID for the network", + "description": "the VPC network belongs to", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, "type": "uuid" }, { - "description": "the beginning IP address in the network IP range", + "description": "the gateway of the IPv6 network. Required for Shared networks", "length": 255, - "name": "startip", + "name": "ip6gateway", "required": false, "type": "string" }, { - "description": "network domain", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "networkdomain", + "name": "displaynetwork", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks", + "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "ip6gateway", + "name": "netmask", "required": false, "type": "string" }, @@ -76322,39 +81869,38 @@ "type": "string" }, { - "description": "The network this network is associated to. only available if create a Shared network", + "description": "network domain", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "networkdomain", "required": false, - "since": "4.17.0", - "type": "uuid" + "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "description": "the beginning IP address in the network IP range", "length": 255, - "name": "displaynetwork", + "name": "startip", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the isolated private VLAN for this network", + "description": "MTU to be configured on the network VR's private interface(s)", "length": 255, - "name": "isolatedpvlan", + "name": "privatemtu", "required": false, - "type": "string" + "since": "4.18.0", + "type": "integer" }, { - "description": "the isolated private VLAN type for this network", + "description": "the isolated private VLAN for this network", "length": 255, - "name": "isolatedpvlantype", + "name": "isolatedpvlan", "required": false, "type": "string" }, { - "description": "ID of the network in an external system.", + "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "externalid", + "name": "gateway", "required": false, "type": "string" }, @@ -76366,34 +81912,34 @@ "type": "string" }, { - "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "the second IPv4 DNS for the network", "length": 255, - "name": "netmask", + "name": "dns2", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "the network offering ID", "length": 255, - "name": "gateway", - "required": false, - "type": "string" + "name": "networkofferingid", + "related": "listNetworkOfferings", + "required": true, + "type": "uuid" }, { - "description": "the physical network ID the network belongs to", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "ip6cidr", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "domain ID of the account owning a network", + "description": "ID of the network in an external system.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "externalid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network", @@ -76403,69 +81949,70 @@ "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": "IPV6 address to be assigned to a router in a shared network", "length": 255, - "name": "subdomainaccess", + "name": "routeripv6", "required": false, - "type": "boolean" + "since": "4.16", + "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "the first IPv4 DNS for the network", "length": 255, - "name": "endipv6", + "name": "dns1", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "an optional project for the network", + "description": "the display text of the network", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Network ACL ID associated for the network", + "description": "an optional project for the network", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", "length": 255, - "name": "hideipaddressusage", + "name": "bypassvlanoverlapcheck", "required": false, "type": "boolean" }, { - "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", + "description": "the second IPv6 DNS for the network", "length": 255, - "name": "endip", + "name": "ip6dns2", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "IPV4 address to be assigned to a router in a shared network", + "description": "domain ID of the account owning a network", "length": 255, - "name": "routerip", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.16", - "type": "string" + "type": "uuid" }, { - "description": "the VPC network belongs to", + "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "endip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID or VID of the network", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "vlan", + "name": "endipv6", "required": false, "type": "string" } @@ -76473,125 +82020,124 @@ "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "zone id of the network", - "name": "zoneid", - "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 supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the first DNS for the network", - "name": "dns1", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "related to what other network configuration", - "name": "related", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, - {}, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the name of the network", - "name": "name", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "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 details of the network", + "name": "details", + "type": "map" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "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": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { "description": "the id of the network", @@ -76599,18 +82145,23 @@ "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { @@ -76624,38 +82175,28 @@ "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { @@ -76664,39 +82205,24 @@ "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": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { "description": "true network requires restart", @@ -76704,23 +82230,13 @@ "type": "boolean" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { @@ -76728,13 +82244,18 @@ "name": "tags", "response": [ { - "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": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -76748,78 +82269,168 @@ "type": "string" }, { - "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" }, { - "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 name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "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 users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, { "description": "the domain name of the network owner", "name": "domain", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, {}, + { + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" + }, { "description": "the network's gateway", "name": "gateway", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { "description": "the list of services", @@ -76829,11 +82440,6 @@ "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", @@ -76843,6 +82449,11 @@ "description": "the capability name", "name": "name", "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" } ], "type": "list" @@ -76852,28 +82463,23 @@ "name": "provider", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -76881,6 +82487,11 @@ "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", @@ -76897,46 +82508,12 @@ ], "type": "list" }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "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": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" - }, - { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" - }, { "description": "The routes for the network to ease adding route in upstream router", "name": "ip6routes", "type": "set" }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the type of the network", - "name": "type", - "type": "string" - } + {} ] }, { @@ -76945,18 +82522,13 @@ "name": "listNetworkOfferings", "params": [ { - "description": "list by traffic type", - "length": 255, - "name": "traffictype", - "required": false, - "type": "string" - }, - { - "description": "true if offering has tags specified", + "description": "list network offerings available for network creation in specific domain", "length": 255, - "name": "istagged", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "since": "4.13", + "type": "uuid" }, { "description": "list network offerings by name", @@ -76966,68 +82538,70 @@ "type": "string" }, { - "description": "list network offerings supporting certain services", + "description": "the availability of network offering. Default value is required", "length": 255, - "name": "supportedservices", + "name": "availability", "required": false, - "type": "list" + "type": "string" }, { - "description": "true if need to list only default network offerings. Default value is false", - "length": 255, - "name": "isdefault", + "description": "list network offerings by tags", + "length": 4096, + "name": "tags", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network offerings by display text", + "description": "list network offerings by ID", "length": 255, - "name": "displaytext", + "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": "the tags for the network offering.", "length": 255, - "name": "sourcenatsupported", + "name": "specifyvlan", "required": false, "type": "boolean" }, { - "description": "List by keyword", + "description": "list by traffic type", "length": 255, - "name": "keyword", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "list network offerings by ID", + "description": "list network offerings available for network creation in specific zone", "length": 255, - "name": "id", - "related": "listNetworkOfferings", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "list network offerings by state", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the network offering can be used only for network creation inside the VPC", + "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": "forvpc", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list network offerings by state", + "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", "length": 255, - "name": "state", + "name": "sourcenatsupported", "required": false, - "type": "string" + "type": "boolean" }, { "description": "true if need to list only network offerings which support specifying ip ranges", @@ -77037,36 +82611,40 @@ "type": "boolean" }, { - "description": "the availability of network offering. Default value is required", + "description": "List by keyword", "length": 255, - "name": "availability", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list network offerings available for network creation in specific domain", + "description": "the network offering can be used only for network creation inside the VPC", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "forvpc", "required": false, - "since": "4.13", - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.", + "description": "list network offerings supporting certain services", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "supportedservices", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the tags for the network offering.", + "description": "true if offering has tags specified", "length": 255, - "name": "specifyvlan", + "name": "istagged", "required": false, "type": "boolean" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "list network offerings by guest type: shared or isolated", "length": 255, @@ -77075,171 +82653,102 @@ "type": "string" }, { - "description": "", + "description": "list network offerings by display text", "length": 255, - "name": "pagesize", + "name": "displaytext", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list network offerings by tags", - "length": 4096, - "name": "tags", + "description": "", + "length": 255, + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list network offerings available for network creation in specific zone", + "description": "true if need to list only default network offerings. Default value is false", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "isdefault", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "", "response": [ { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" + "description": "availability of the network offering", + "name": "availability", + "type": "string" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", + "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": "true if network offering can be used by VPC networks only", "name": "forvpc", "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": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the id of the network offering", - "name": "id", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "the id of the network offering", + "name": "id", + "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the name of the network offering", - "name": "name", - "type": "string" + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { @@ -77248,24 +82757,29 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "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 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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" }, { "description": "guest type of the network offering, can be Shared or Isolated", @@ -77273,58 +82787,126 @@ "type": "string" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "the name of the network offering", + "name": "name", "type": "string" }, + {}, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", + "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": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" } ] @@ -77335,41 +82917,41 @@ "name": "listDedicatedPods", "params": [ { - "description": "", + "description": "the ID of the domain associated with the pod", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the name of the account associated with the pod. Must be used with domainId.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of the domain associated with the pod", + "description": "list dedicated pods by affinity group", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "affinitygroupid", + "related": "", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list dedicated pods by affinity group", + "description": "", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the ID of the pod", @@ -77380,11 +82962,11 @@ "type": "uuid" }, { - "description": "", + "description": "the name of the account associated with the pod. Must be used with domainId.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" } ], "related": "", @@ -77400,26 +82982,26 @@ "type": "integer" }, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "description": "the ID of the Pod", + "name": "podid", "type": "string" }, { - "description": "the Name of the Pod", - "name": "podname", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" }, - {}, { - "description": "the ID of the Pod", - "name": "podid", + "description": "the Name of the Pod", + "name": "podname", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -77445,14 +83027,6 @@ "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" - }, { "description": "the ID of the virtual machine", "length": 255, @@ -77460,59 +83034,79 @@ "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": true, "type": "uuid" + }, + { + "description": "Destination Host ID to migrate VM to.", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "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,importUnmanagedInstance", "response": [ { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + {}, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "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 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": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the write (IO) of disk on the VM", @@ -77520,106 +83114,190 @@ "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "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": "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "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 name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, { "description": "List of read-only Vm details as comma separated string.", "name": "readonlydetails", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "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 group ID of the virtual machine", - "name": "groupid", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", + "description": "the account owning the affinity group", "name": "account", "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 value", - "name": "value", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the affinity group", + "name": "name", "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" }, { - "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": "resource type", - "name": "resourcetype", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the ID of the availablility 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 name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -77628,9 +83306,39 @@ "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the 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": "Base64 string representation of the resource icon", @@ -77638,42 +83346,37 @@ "type": "resourceiconresponse" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { "description": "the name of the virtual machine", "name": "name", "type": "string" }, - { - "description": "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 corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -77682,38 +83385,33 @@ "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -77722,197 +83420,111 @@ "type": "list" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the IPv6 address of network", + "name": "ip6address", "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 ID of the nic", - "name": "id", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the type of the nic", + "name": "type", "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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 traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - } - ], - "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": "publicip", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "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 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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + } + ], + "type": "set" }, - {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "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 memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { @@ -77921,86 +83533,122 @@ "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, - {}, { - "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 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": "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "resource type", + "name": "resourcetype", "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": "security group name", - "name": "securitygroupname", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "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 name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -78009,28 +83657,28 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -78039,21 +83687,31 @@ "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 code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -78062,8 +83720,18 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -78075,27 +83743,17 @@ "type": "set" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the 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", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -78109,8 +83767,13 @@ "type": "integer" }, { - "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 code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -78119,29 +83782,14 @@ "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { "description": "the 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": "id of the resource", "name": "resourceid", @@ -78163,8 +83811,13 @@ "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", "type": "string" }, { @@ -78173,26 +83826,31 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", + "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": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], @@ -78204,71 +83862,19 @@ "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the name of the security group", + "name": "name", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "the description of the security group", + "name": "description", + "type": "string" }, { "description": "the domain ID of the security group", @@ -78276,154 +83882,175 @@ "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the project name of the group", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name of the group", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", "name": "project", "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" } ], "type": "set" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of userdata used for the VM", + "name": "userdataname", "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" } ] }, @@ -78433,91 +84060,99 @@ "name": "listVPCs", "params": [ { - "description": "List by display text of the VPC", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "displaytext", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "list VPC by id", + "description": "list VPCs by restartRequired option", "length": 255, - "name": "id", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "restartrequired", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list VPCs by state", + "description": "list by name of the VPC", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List by display text of the VPC", "length": 255, - "name": "listall", + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "tags", + "name": "isrecursive", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "list by ID of the VPC offering", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "vpcofferingid", + "related": "updateVPCOffering", "required": false, "type": "uuid" }, { - "description": "flag to display the resource icon for VPCs", + "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": "list objects by project; if projectid=-1 lists All VMs", + "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "cidr", "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": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list VPCs by restartRequired option", + "description": "list VPC by id", "length": 255, - "name": "restartrequired", + "name": "id", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "list VPC supporting certain services", @@ -78527,19 +84162,20 @@ "type": "list" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list by zone", "length": 255, - "name": "fordisplay", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "keyword", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -78549,32 +84185,23 @@ "type": "string" }, { - "description": "list by name of the VPC", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "list by zone", + "description": "flag to display the resource icon for VPCs", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list by ID of the VPC offering", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "list VPCs by state", "length": 255, - "name": "cidr", + "name": "state", "required": false, "type": "string" } @@ -78582,274 +84209,299 @@ "related": "createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "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", + "type": "integer" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, + { + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, - {}, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the cidr the VPC", + "name": "cidr", + "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "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 project name of the VPC", + "name": "project", + "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "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 the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "the id of the VPC", - "name": "id", + "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", - "type": "integer" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { "description": "the name of the VPC", "name": "name", "type": "string" }, + {}, { - "description": "the project name of the VPC", - "name": "project", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, { "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the owner of the VPC", + "name": "account", + "type": "string" }, { "description": "the domain name of the owner", "name": "domain", "type": "string" }, + {}, { - "description": "the list of resource tags associated with the project", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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 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" - } - ], - "type": "list" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - } - ], - "type": "list" - }, - { - "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": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" } ] }, @@ -78875,13 +84527,13 @@ ], "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", @@ -78900,12 +84552,11 @@ "name": "runDiagnostics", "params": [ { - "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 IP/Domain address to test connection to", @@ -78915,47 +84566,48 @@ "type": "string" }, { - "description": "Additional command line options that apply for each command", + "description": "The ID of the system VM instance to diagnose", "length": 255, - "name": "params", - "required": false, - "type": "string" + "name": "targetid", + "related": "migrateSystemVm,startSystemVm", + "required": true, + "type": "uuid" }, { - "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", + "description": "Additional command line options that apply for each command", "length": 255, - "name": "type", - "required": true, + "name": "params", + "required": false, "type": "string" } ], "related": "", "response": [ { - "description": "the standard error output from the command execution", - "name": "stderr", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the command execution return code", - "name": "exitcode", + "description": "the standard output from the command execution", + "name": "stdout", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the standard output from the command execution", - "name": "stdout", + "description": "the standard error output from the command execution", + "name": "stderr", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the command execution return code", + "name": "exitcode", "type": "string" } ], @@ -78967,16 +84619,17 @@ "name": "updateUser", "params": [ { - "description": "The secret key for the user. Must be specified with userApiKey", + "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": "usersecretkey", + "name": "mandate2fa", "required": false, - "type": "string" + "since": "4.18.0.0", + "type": "boolean" }, { - "description": "Unique username", + "description": "The API key for the user. Must be specified with userSecretKey", "length": 255, - "name": "username", + "name": "userapikey", "required": false, "type": "string" }, @@ -78988,31 +84641,38 @@ "type": "string" }, { - "description": "email", + "description": "User uuid", "length": 255, - "name": "email", + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", + "required": true, + "type": "uuid" + }, + { + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "length": 255, + "name": "timezone", "required": false, "type": "string" }, { - "description": "Current password that was being used by the user. You must inform the current password when updating the password.", + "description": "email", "length": 255, - "name": "currentpassword", + "name": "email", "required": false, "type": "string" }, { - "description": "User uuid", + "description": "The secret key for the user. Must be specified with userApiKey", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", - "required": true, - "type": "uuid" + "name": "usersecretkey", + "required": false, + "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" }, @@ -79024,37 +84684,31 @@ "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Current password that was being used by the user. You must inform the current password when updating the password.", "length": 255, - "name": "timezone", + "name": "currentpassword", "required": false, "type": "string" }, { - "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "description": "Unique username", "length": 255, - "name": "password", + "name": "username", "required": false, "type": "string" } ], "related": "createUser,disableUser,enableUser,getUser,listUsers", "response": [ - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, { "description": "the account type of the user", "name": "accounttype", "type": "integer" }, - {}, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { "description": "the timezone user was created in", @@ -79062,105 +84716,121 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the 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 state", - "name": "state", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { "description": "the type of the role", "name": "roletype", "type": "string" }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + {}, { "description": "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 date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user state", + "name": "state", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the user email address", - "name": "email", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, + {}, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the user firstname", + "name": "firstname", + "type": "string" } ] }, @@ -79170,12 +84840,11 @@ "name": "restartVPC", "params": [ { - "description": "the id of the VPC", + "description": "Turn a single VPC into a redundant one.", "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" + "name": "makeredundant", + "required": false, + "type": "boolean" }, { "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", @@ -79186,11 +84855,12 @@ "type": "boolean" }, { - "description": "Turn a single VPC into a redundant one.", + "description": "the id of the VPC", "length": 255, - "name": "makeredundant", - "required": false, - "type": "boolean" + "name": "id", + "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" }, { "description": "If cleanup old network elements", @@ -79201,21 +84871,21 @@ } ], "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": "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" }, {}, { @@ -79240,27 +84910,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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -79278,10 +84948,10 @@ "type": "uuid" }, { - "description": "the host URL", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "url", - "required": true, + "name": "allocationstate", + "required": false, "type": "string" }, { @@ -79291,13 +84961,6 @@ "required": false, "type": "string" }, - { - "description": "Allocation state of this Host for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, { "description": "list of tags to be added to the host", "length": 255, @@ -79314,12 +84977,19 @@ "type": "uuid" }, { - "description": "the cluster name for the host", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "clustername", + "name": "username", "required": false, "type": "string" }, + { + "description": "hypervisor type of the host", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, { "description": "the Zone ID for the host", "length": 255, @@ -79329,40 +84999,65 @@ "type": "uuid" }, { - "description": "hypervisor type of the host", + "description": "the host URL", "length": 255, - "name": "hypervisor", + "name": "url", "required": true, "type": "string" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "the cluster name for the host", "length": 255, - "name": "username", + "name": "clustername", "required": false, "type": "string" } ], - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", "response": [ { - "description": "the cluster name of the host", - "name": "clustername", + "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 total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { @@ -79370,53 +85065,88 @@ "name": "suitableformigration", "type": "boolean" }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" + }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, { "description": "the amount of the host's CPU currently allocated in percentage", "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "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 amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", "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", + "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": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" }, { "description": "Maximum Y resolution per display", @@ -79424,141 +85154,156 @@ "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { - "description": "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" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "description": "the ID of the host", - "name": "id", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "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 management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + {}, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "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 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 last annotation set on this host by an admin", - "name": "annotation", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + }, + { + "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": "events available for the host", - "name": "events", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { "description": "the state of the host", @@ -79566,54 +85311,39 @@ "type": "status" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { "description": "the host type", @@ -79626,39 +85356,19 @@ "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", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, {}, - { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, { "description": "the amount of the host's CPU currently allocated in MHz", "name": "cpuallocatedvalue", "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { @@ -79666,45 +85376,10 @@ "name": "name", "type": "string" }, - { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" - }, - { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, - { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" - }, { "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", "name": "cpuallocatedwithoverprovisioning", "type": "string" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" } ] }, @@ -79713,6 +85388,14 @@ "isasync": true, "name": "attachVolume", "params": [ + { + "description": " the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" + }, { "description": "the ID of the disk volume", "length": 255, @@ -79727,95 +85410,118 @@ "name": "deviceid", "required": false, "type": "long" - }, - { - "description": " the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" } ], "related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, - {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "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": "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": "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" + } + ], + "type": "set" }, {}, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, - { - "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 project name of the vpn", "name": "project", @@ -79827,25 +85533,20 @@ "type": "boolean" }, { - "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": "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": "the 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 virtual machine", + "name": "vmstate", "type": "string" }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, { "description": "IO requests write rate of the disk volume per the disk offering", "name": "diskIopsWriteRate", @@ -79857,177 +85558,130 @@ "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, { "description": "cluster name where the volume is allocated", "name": "clustername", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { "description": "the domain associated with the disk volume", "name": "domain", "type": "string" }, + { + "description": "the 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 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": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "name of the virtual machine", "name": "vmname", @@ -80049,24 +85703,40 @@ "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the account associated with the disk volume", + "name": "account", + "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 read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + {}, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { "description": "name of the availability zone", @@ -80074,58 +85744,68 @@ "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "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": "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": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "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" } ] @@ -80136,20 +85816,12 @@ "name": "addBaremetalDhcp", "params": [ { - "description": "Type of dhcp device", + "description": "URL of the external dhcp appliance.", "length": 255, - "name": "dhcpservertype", + "name": "url", "required": true, "type": "string" }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - }, { "description": "Credentials to reach external dhcp device", "length": 255, @@ -80165,25 +85837,32 @@ "type": "string" }, { - "description": "URL of the external dhcp appliance.", + "description": "Type of dhcp device", "length": 255, - "name": "url", + "name": "dhcpservertype", "required": true, "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" } ], "related": "listBaremetalDhcp", "response": [ { - "description": "url", - "name": "url", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the provider", + "name": "dhcpservertype", "type": "string" }, { @@ -80192,40 +85871,79 @@ "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": "name of the provider", - "name": "provider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "url", + "name": "url", "type": "string" }, + {}, { "description": "name of the provider", - "name": "dhcpservertype", + "name": "provider", "type": "string" } ] }, { - "description": "Adds Traffic Monitor Host for Direct Network Usage", - "isasync": false, - "name": "addTrafficMonitor", + "description": "delete Tungsten-Fabric application policy set", + "isasync": true, + "name": "deleteTungstenFabricApplicationPolicySet", "params": [ { - "description": "Zone in which to add the external firewall appliance.", + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", "length": 255, "name": "zoneid", "related": "createZone,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": "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": "Adds Traffic Monitor Host for Direct Network Usage", + "isasync": false, + "name": "addTrafficMonitor", + "params": [ { "description": "Traffic going into the listed zones will be metered", "length": 255, @@ -80233,6 +85951,13 @@ "required": false, "type": "string" }, + { + "description": "URL of the traffic monitor Host", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, { "description": "Traffic going into the listed zones will not be metered", "length": 255, @@ -80241,52 +85966,53 @@ "type": "string" }, { - "description": "URL of the traffic monitor Host", + "description": "Zone in which to add the external firewall appliance.", "length": 255, - "name": "url", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "the ID of the external firewall", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "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" - } + }, + {} ] }, { @@ -80295,18 +86021,12 @@ "name": "updateProject", "params": [ { - "description": "display text of the project", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "Account level role to be assigned to the user/account : Admin/Regular", + "description": "id of the project to be modified", "length": 255, - "name": "roletype", - "required": false, - "type": "string" + "name": "id", + "related": "activateProject,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { "description": "new Admin account for the project", @@ -80316,11 +86036,11 @@ "type": "string" }, { - "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", + "description": "Account level role to be assigned to the user/account : Admin/Regular", "length": 255, - "name": "swapowner", + "name": "roletype", "required": false, - "type": "boolean" + "type": "string" }, { "description": "ID of the user to be promoted/demoted", @@ -80331,65 +86051,126 @@ "type": "uuid" }, { - "description": "id of the project to be modified", + "description": "display text of the project", "length": 255, - "name": "id", - "related": "activateProject,suspendProject,updateProject", - "required": true, - "type": "uuid" + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", + "length": 255, + "name": "swapowner", + "required": false, + "type": "boolean" } ], "related": "activateProject,suspendProject", "response": [ + { + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, { "description": "the total number of cpu cores owned by project", "name": "cputotal", "type": "long" }, { - "description": "the id of the project", - "name": "id", + "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 available for this project to acquire", - "name": "ipavailable", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the project", + "name": "id", + "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) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total number of 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", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" }, { "description": "the total number of cpu cores the project can own", @@ -80397,9 +86178,19 @@ "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" }, { "description": "the total number of vpcs owned by project", @@ -80407,18 +86198,24 @@ "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" }, + {}, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { @@ -80427,9 +86224,9 @@ "type": "long" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "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) owned by project", @@ -80437,47 +86234,47 @@ "type": "float" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -80486,46 +86283,42 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, + {}, { - "description": "the state of the project", - "name": "state", - "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" }, { @@ -80534,106 +86327,39 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", - "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", - "type": "string" - }, - { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, - { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" - }, - {}, { "description": "the total number of virtual machines running for this project", "name": "vmrunning", "type": "integer" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "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 networks owned by project", + "name": "networktotal", + "type": "long" } ], "since": "3.0.0" @@ -80644,33 +86370,33 @@ "name": "listLoadBalancers", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the name of the load balancer", "length": 255, - "name": "fordisplay", + "name": "name", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the source IP address of the load balancer", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "sourceipaddress", + "name": "account", "required": false, "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the network ID of the source IP address", "length": 255, - "name": "listall", + "name": "sourceipaddressnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List resources by tags (key/value pairs)", @@ -80680,27 +86406,19 @@ "type": "map" }, { - "description": "the name of the load balancer", + "description": "the scheme of the load balancer. Supported value is internal in the current release", "length": 255, - "name": "name", + "name": "scheme", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, - { - "description": "the network ID of the source IP address", - "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, { "description": "the network ID of the load balancer", "length": 255, @@ -80709,13 +86427,6 @@ "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -80725,19 +86436,19 @@ "type": "uuid" }, { - "description": "the scheme of the load balancer. Supported value is internal in the current release", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "scheme", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "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": "the ID of the load balancer", @@ -80748,54 +86459,71 @@ "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the source IP address of the load balancer", "length": 255, - "name": "account", + "name": "sourceipaddress", "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": "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": "createLoadBalancer", "response": [ { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the name of the Load Balancer", - "name": "name", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Load Balancer network id", + "name": "networkid", "type": "string" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, + {}, { "description": "the list of instances associated with the Load Balancer", "name": "loadbalancerinstance", "response": [ { - "description": "the name of the instance", - "name": "name", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" }, { - "description": "the ip address of the instance", - "name": "ipaddress", + "description": "the state of the instance", + "name": "state", "type": "string" }, { @@ -80804,8 +86532,8 @@ "type": "string" }, { - "description": "the state of the instance", - "name": "state", + "description": "the name of the instance", + "name": "name", "type": "string" } ], @@ -80816,68 +86544,29 @@ "name": "description", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" - }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "the 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 project id of the Load Balancer", "name": "projectid", "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" }, - {}, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { @@ -80885,13 +86574,8 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -80899,19 +86583,14 @@ "name": "customer", "type": "string" }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -80919,29 +86598,76 @@ "name": "project", "type": "string" }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "the Load Balancer ID", - "name": "id", + "description": "the domain of the Load Balancer", + "name": "domain", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" + }, + { + "description": "the account of the Load Balancer", + "name": "account", "type": "string" }, + { + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + }, + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + }, + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + } + ], + "type": "list" + }, { "description": "the project name of the Load Balancer", "name": "project", @@ -80963,19 +86689,33 @@ "type": "boolean" }, { - "description": "List user by ID.", + "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers", + "name": "accounttype", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "List user by the username", "length": 255, - "name": "pagesize", + "name": "username", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "flag to display the resource icon for users", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + }, + { + "description": "List user by ID.", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers", + "required": false, + "type": "uuid" }, { "description": "List by keyword", @@ -80991,6 +86731,13 @@ "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, @@ -81006,20 +86753,6 @@ "required": false, "type": "integer" }, - { - "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", - "length": 255, - "name": "accounttype", - "required": false, - "type": "integer" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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 users by state of the user account.", "length": 255, @@ -81028,30 +86761,48 @@ "type": "string" }, { - "description": "List user by the username", - "length": 255, - "name": "username", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "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 account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { @@ -81060,8 +86811,8 @@ "type": "boolean" }, { - "description": "the user ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -81069,102 +86820,87 @@ "name": "username", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, { "description": "the date and time the user account was created", "name": "created", "type": "date" }, { - "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 domain name of the user", - "name": "domain", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, + {}, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the user state", + "name": "state", "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 secret key of the user", - "name": "secretkey", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the api key of the user", - "name": "apikey", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, - {}, { - "description": "the user state", - "name": "state", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user ID", + "name": "id", "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 user firstname", - "name": "firstname", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" } ] }, @@ -81194,18 +86930,18 @@ "name": "apikey", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "the secret key of the registered user", "name": "secretkey", "type": "string" }, - {} + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -81223,28 +86959,28 @@ } ], "response": [ + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ], "since": "3.0.0" }, @@ -81254,30 +86990,37 @@ "name": "updateVlanIpRange", "params": [ { - "description": "the beginning IP address in the VLAN IP range", + "description": "the gateway of the IPv6 network", "length": 255, - "name": "startip", + "name": "ip6gateway", "required": false, "type": "string" }, { - "description": "the ending IP address in the VLAN IP range", + "description": "the gateway of the VLAN IP range", "length": 255, - "name": "endip", + "name": "gateway", "required": false, "type": "string" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "forsystemvms", + "name": "ip6cidr", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "startipv6", + "name": "endipv6", + "required": false, + "type": "string" + }, + { + "description": "the netmask of the VLAN IP range", + "length": 255, + "name": "netmask", "required": false, "type": "string" }, @@ -81290,37 +87033,30 @@ "type": "uuid" }, { - "description": "the CIDR of IPv6 network, must be at least /64", - "length": 255, - "name": "ip6cidr", - "required": false, - "type": "string" - }, - { - "description": "the gateway of the IPv6 network", + "description": "the beginning IP address in the VLAN IP range", "length": 255, - "name": "ip6gateway", + "name": "startip", "required": false, "type": "string" }, { - "description": "the netmask of the VLAN IP range", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "netmask", + "name": "startipv6", "required": false, "type": "string" }, { - "description": "the gateway of the VLAN IP range", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "gateway", + "name": "forsystemvms", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "the ending IP address in the VLAN IP range", "length": 255, - "name": "endipv6", + "name": "endip", "required": false, "type": "string" } @@ -81328,33 +87064,35 @@ "related": "dedicatePublicIpRange", "response": [ { - "description": "the project id of the vlan range", - "name": "projectid", + "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 gateway of the VLAN IP range", + "name": "gateway", "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 ID or VID of the VLAN.", - "name": "vlan", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, + {}, + {}, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -81363,44 +87101,43 @@ "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, - {}, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", + "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", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -81409,55 +87146,54 @@ "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, - {}, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "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 ID of the VLAN IP range", + "name": "id", + "type": "string" } ], "since": "4.16.0" @@ -81468,18 +87204,11 @@ "name": "listVpnConnections", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "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": "id of the vpn connection", @@ -81489,6 +87218,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -81498,26 +87234,26 @@ "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": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "id of vpc", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -81528,58 +87264,49 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "id of vpc", "length": 255, - "name": "keyword", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "isrecursive", "required": false, - "type": "uuid" + "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" } ], "related": "createVpnConnection", "response": [ { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "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": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "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", - "type": "string" - }, - { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", + "name": "passive", "type": "boolean" }, { @@ -81588,29 +87315,39 @@ "type": "long" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", "type": "boolean" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "public ip address id of the customer gateway", + "name": "gateway", "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 DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { "description": "the project id", @@ -81618,13 +87355,18 @@ "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the connection ID", + "name": "id", "type": "string" }, { @@ -81634,18 +87376,8 @@ }, {}, { - "description": "the owner", - "name": "account", - "type": "string" - }, - { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "the connection ID", - "name": "id", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { @@ -81654,8 +87386,13 @@ "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "is connection for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { @@ -81664,29 +87401,28 @@ "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, - {}, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the owner", + "name": "account", "type": "string" } ] @@ -81697,47 +87433,46 @@ "name": "listResourceLimits", "params": [ { - "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": "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": "", "length": 255, - "name": "resourcetype", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "Lists resource limits by ID.", "length": 255, - "name": "listall", + "name": "id", "required": false, - "type": "boolean" + "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. ", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "resourcetypename", + "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 by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -81750,28 +87485,29 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Lists resource limits by ID.", + "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": "id", + "name": "resourcetype", "required": false, - "type": "long" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, - "name": "account", + "name": "resourcetypename", "required": false, "type": "string" } @@ -81779,44 +87515,39 @@ "related": "", "response": [ { - "description": "the project name of the resource limit", - "name": "project", + "description": "the account of the resource limit", + "name": "account", "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, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", + "name": "resourcetype", "type": "string" }, { - "description": "the project id of the resource limit", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the domain ID of the resource limit", "name": "domainid", "type": "string" }, { - "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", + "description": "the project id of the resource limit", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the resource limit", + "name": "project", "type": "string" }, {}, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "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" }, { @@ -81825,9 +87556,14 @@ "type": "string" }, { - "description": "the account of the resource limit", - "name": "account", - "type": "string" + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {} ] @@ -81848,16 +87584,20 @@ ], "related": "createUser,enableUser,getUser", "response": [ - {}, { - "description": "the api key of the user", - "name": "apikey", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the ID of the role", @@ -81865,13 +87605,8 @@ "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the domain name of the user", - "name": "domain", + "description": "the user ID", + "name": "id", "type": "string" }, { @@ -81884,24 +87619,70 @@ "name": "created", "type": "date" }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, { "description": "the account type of the user", "name": "accounttype", "type": "integer" }, { - "description": "the account name of the user", - "name": "account", + "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 account ID of the user", - "name": "accountid", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { @@ -81910,8 +87691,8 @@ "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the user email address", + "name": "email", "type": "string" }, { @@ -81920,54 +87701,89 @@ "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user state", + "name": "state", + "type": "string" + } + ] + }, + { + "description": "remove Tungsten-Fabric policy", + "isasync": true, + "name": "removeTungstenFabricPolicy", + "params": [ + { + "description": "the uuid of Tungsten-Fabric network", + "length": 255, + "name": "networkuuid", + "required": true, "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the user ID", - "name": "id", + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, "type": "string" + } + ], + "related": "listTungstenFabricPolicy,applyTungstenFabricPolicy", + "response": [ + {}, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "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": "the timezone user was created in", - "name": "timezone", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, {}, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -81978,25 +87794,32 @@ "name": "listIsos", "params": [ { - "description": "true if the ISO is publicly available to all users, false otherwise.", + "description": "", "length": 255, - "name": "ispublic", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "show removed ISOs as well", + "length": 255, + "name": "showremoved", "required": false, "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list all ISOs by name", "length": 255, - "name": "tags", + "name": "name", "required": false, - "type": "map" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list ISO by ID", @@ -82007,88 +87830,74 @@ "type": "uuid" }, { - "description": "true if this ISO is ready to be deployed", + "description": "true if the ISO is bootable, false otherwise", "length": 255, - "name": "isready", + "name": "bootable", "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).", + "description": "true if the ISO is publicly available to all users, false otherwise.", "length": 255, - "name": "isofilter", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "account", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "show removed ISOs as well", - "length": 255, - "name": "showremoved", - "required": false, - "type": "boolean" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "true if the ISO is bootable, false otherwise", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "bootable", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list all ISOs by name", + "description": "true if this ISO is ready to be deployed", "length": 255, - "name": "name", + "name": "isready", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "If set to true, list only unique isos across zones", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "showunique", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "flag to display the resource image for the isos", "length": 255, - "name": "listall", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "flag to display the resource image for the isos", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "showicon", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the hypervisor for which to restrict the search", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "hypervisor", + "name": "account", "required": false, "type": "string" }, @@ -82100,49 +87909,61 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "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": "domainid", - "related": "listDomainChildren,listDomains", + "name": "isofilter", + "required": false, + "type": "string" + }, + { + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "If set to true, list only unique isos across zones", "length": 255, - "name": "page", + "name": "showunique", "required": false, - "type": "integer" + "since": "4.13.2", + "type": "boolean" }, { - "description": "the ID of the zone", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "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 userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "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 ID of the zone for this template", - "name": "zoneid", + "description": "the template ID", + "name": "id", "type": "string" }, { @@ -82150,6 +87971,16 @@ "name": "removed", "type": "date" }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, { "description": "the name of the OS type for this template.", "name": "ostypename", @@ -82161,186 +87992,113 @@ "type": "string" }, { - "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": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the 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": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "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": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, - {}, { - "description": "the template ID", - "name": "id", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "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", + "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 the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the tag of this template", - "name": "templatetag", + "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the 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", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, { "description": "the template name", "name": "name", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, { "description": "the 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": "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 account name to which the template belongs", + "name": "account", + "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -82349,60 +88107,133 @@ "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the name of the domain to which the template belongs", + "name": "domain", "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 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": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + {}, + { + "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, - {}, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "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 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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { "description": "the ID of the OS type for this template.", @@ -82410,24 +88241,29 @@ "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" } ] }, @@ -82436,13 +88272,6 @@ "isasync": false, "name": "updateCloudToUseObjectStore", "params": [ - { - "description": "the image store provider name", - "length": 255, - "name": "provider", - "required": true, - "type": "string" - }, { "description": "the name for the image store", "length": 255, @@ -82463,24 +88292,26 @@ "name": "url", "required": false, "type": "string" + }, + { + "description": "the image store provider name", + "length": 255, + "name": "provider", + "required": true, + "type": "string" } ], "related": "listSwifts,addImageStoreS3,listImageStores", "response": [ { - "description": "defines if store is read-only", - "name": "readonly", + "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 protocol of the image store", - "name": "protocol", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -82488,13 +88319,8 @@ "type": "integer" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the url of the image store", + "name": "url", "type": "string" }, { @@ -82502,41 +88328,51 @@ "name": "zoneid", "type": "string" }, - {}, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the protocol of the image store", + "name": "protocol", "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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 Zone name of the image store", + "name": "zonename", + "type": "string" }, - {}, { "description": "the name of the image store", "name": "name", "type": "string" }, + {}, + {}, { - "description": "the url of the image store", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -82548,27 +88384,36 @@ "name": "listAutoScalePolicies", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the ID of the condition of the policy", "length": 255, - "name": "listall", + "name": "conditionid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the autoscale vm group", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "vmgroupid", - "related": "listAutoScaleVmGroups", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, "type": "uuid" }, + { + "description": "the name of the autoscale policy", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", + "type": "string" + }, { "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, @@ -82577,20 +88422,18 @@ "type": "string" }, { - "description": "the ID of the condition of the policy", + "description": "", "length": 255, - "name": "conditionid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -82600,50 +88443,60 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the autoscale policy", "length": 255, - "name": "account", + "name": "id", + "related": "listAutoScalePolicies", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the ID of the autoscale vm group", "length": 255, - "name": "keyword", + "name": "vmgroupid", + "related": "listAutoScaleVmGroups", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the autoscale policy", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "listAutoScalePolicies", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" } ], "related": "", "response": [ { - "description": "the autoscale policy ID", - "name": "id", + "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 domain ID of the autoscale policy", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -82651,24 +88504,14 @@ "name": "action", "type": "string" }, - { - "description": "the project name of the autoscale policy", - "name": "project", - "type": "string" - }, { "description": "the project id autoscale policy", "name": "projectid", "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { @@ -82676,18 +88519,32 @@ "name": "account", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain name of the autoscale policy", + "name": "domain", + "type": "string" }, { "description": "the cool down period for which the policy should not be evaluated after the action has been taken", "name": "quiettime", "type": "integer" }, + { + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" + }, {}, + { + "description": "the domain ID of the autoscale policy", + "name": "domainid", + "type": "string" + }, + { + "description": "name of the autoscale policy", + "name": "name", + "type": "string" + }, { "description": "the list of IDs of the conditions that are being evaluated on every interval", "name": "conditions", @@ -82710,7 +88567,6 @@ ], "related": "", "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -82718,8 +88574,8 @@ }, {}, { - "description": "url", - "name": "url", + "description": "id of rct", + "name": "id", "type": "string" }, { @@ -82727,26 +88583,88 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "id of rct", - "name": "id", + "description": "url", + "name": "url", "type": "string" } ] }, { - "description": "Updates a role", - "isasync": false, - "name": "updateRole", + "description": "add Tungsten-Fabric network gateway to logical router", + "isasync": true, + "name": "addTungstenFabricNetworkGatewayToLogicalRouter", "params": [ { - "description": "ID of the role", + "description": "Tungsten-Fabric network uuid", "length": 255, - "name": "id", - "related": "importRole,listRoles,updateRole", + "name": "networkuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, "type": "uuid" }, + { + "description": "Tungsten-Fabric logical router uuid", + "length": 255, + "name": "logicalrouteruuid", + "required": true, + "type": "string" + } + ], + "related": "removeTungstenFabricNetworkGatewayFromLogicalRouter", + "response": [ + { + "description": "Tungsten-Fabric logical router name", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "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": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + {}, + { + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + } + ] + }, + { + "description": "Updates a role", + "isasync": false, + "name": "updateRole", + "params": [ { "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, @@ -82768,6 +88686,14 @@ "required": false, "type": "string" }, + { + "description": "ID of the role", + "length": 255, + "name": "id", + "related": "importRole,listRoles,updateRole", + "required": true, + "type": "uuid" + }, { "description": "The description of the role", "length": 255, @@ -82783,48 +88709,211 @@ "name": "jobid", "type": "string" }, + { + "description": "the name of the role", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "id", + "type": "string" + }, { "description": "the type of the role", "name": "type", "type": "string" }, + { + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + {}, + {}, { "description": "the description of the role", "name": "description", "type": "string" }, { - "description": "the ID of the role", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.9.0" + }, + { + "description": "list Tungsten-Fabric nic", + "isasync": false, + "name": "listTungstenFabricNic", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric nic", + "length": 255, + "name": "nicuuid", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "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": "Tungsten-Fabric nic name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric nic uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Retrieves VMware DC(s) associated with a zone.", + "isasync": false, + "name": "listVmwareDcs", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "Id of the CloudStack zone.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "addVmwareDc", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "The VMware Datacenter ID", "name": "id", "type": "string" }, { - "description": "the name of the role", + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" + }, + { + "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": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - {}, - {} - ], - "since": "4.9.0" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] }, { - "description": "Retrieves VMware DC(s) associated with a zone.", - "isasync": false, - "name": "listVmwareDcs", + "description": "apply Tungsten-Fabric policy", + "isasync": true, + "name": "applyTungstenFabricPolicy", "params": [ { - "description": "Id of the CloudStack zone.", + "description": "the uuid of network", + "length": 255, + "name": "networkuuid", + "required": true, + "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", "length": 255, "name": "zoneid", "related": "createZone,listZones,listZones", @@ -82832,61 +88921,60 @@ "type": "uuid" }, { - "description": "", + "description": "the minor sequence of Tungsten-Fabric policy", "length": 255, - "name": "page", - "required": false, + "name": "minorsequence", + "required": true, "type": "integer" }, { - "description": "", + "description": "the major sequence of Tungsten-Fabric policy", "length": 255, - "name": "pagesize", - "required": false, + "name": "majorsequence", + "required": true, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], - "related": "addVmwareDc", + "related": "listTungstenFabricPolicy", "response": [ - {}, { - "description": "The VMware Datacenter name", + "description": "Tungsten-Fabric policy name", "name": "name", "type": "string" }, { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the Zone ID associated with this VMware Datacenter", + "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", "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" + } ] }, { @@ -82902,12 +88990,20 @@ "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" }, + { + "description": "List zones by resource tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "since": "4.3", + "type": "map" + }, { "description": "the name of the zone", "length": 255, @@ -82924,26 +89020,25 @@ "type": "uuid" }, { - "description": "the network type of the zone that the virtual machine belongs to", + "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": "networktype", + "name": "available", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "since": "4.3", - "type": "map" + "type": "integer" }, { - "description": "flag to display the capacity of the zones", + "description": "the network type of the zone that the virtual machine belongs to", "length": 255, - "name": "showcapacities", + "name": "networktype", "required": false, - "type": "boolean" + "type": "string" }, { "description": "List by keyword", @@ -82953,9 +89048,9 @@ "type": "string" }, { - "description": "flag to display the resource image for the zones", + "description": "flag to display the capacity of the zones", "length": 255, - "name": "showicon", + "name": "showcapacities", "required": false, "type": "boolean" }, @@ -82966,26 +89061,29 @@ "related": "createZone,listZones,listZones", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "createZone,listZones", "response": [ { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "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", - "type": "boolean" + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, + { + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" + }, + { + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", + "type": "string" }, { "description": "the first DNS for the Zone", @@ -82993,72 +89091,74 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, + {}, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, + {}, { - "description": "Zone Token", - "name": "zonetoken", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, { "description": "the capacity name", "name": "name", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { @@ -83067,75 +89167,80 @@ "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Pod name", + "name": "podname", "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", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, { "description": "the total capacity available", "name": "capacitytotal", "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" } ], "type": "list" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -83144,8 +89249,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -83158,6 +89268,11 @@ "name": "projectid", "type": "string" }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", @@ -83167,29 +89282,34 @@ "description": "the project name where tag belongs to", "name": "project", "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" } ], "type": "set" }, { - "description": "the display text of the zone", - "name": "displaytext", + "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 name", + "name": "name", "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" }, { "description": "Meta data associated with the zone (key/value pairs)", @@ -83197,35 +89317,23 @@ "type": "map" }, { - "description": "Zone name", - "name": "name", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, - {}, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "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", - "type": "boolean" - }, - {}, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" } ] @@ -83235,6 +89343,13 @@ "isasync": false, "name": "listRemoteAccessVpns", "params": [ + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -83252,27 +89367,19 @@ "type": "uuid" }, { - "description": "list remote access VPNs for ceratin network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.3", - "type": "uuid" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "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": "", @@ -83282,25 +89389,17 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "public ip address id of the vpn server", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "publicipid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, @@ -83313,26 +89412,35 @@ "type": "boolean" }, { - "description": "public ip address id of the vpn server", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "publicipid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "list remote access VPNs for certain network", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "since": "4.3", + "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": "updateRemoteAccessVpn", "response": [ { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -83341,18 +89449,13 @@ "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", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { @@ -83360,36 +89463,30 @@ "name": "fordisplay", "type": "boolean" }, + {}, { - "description": "the state of the rule", - "name": "state", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, - {}, { "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 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 state of the rule", + "name": "state", "type": "string" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { @@ -83397,9 +89494,20 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "the public ip address of the vpn server", - "name": "publicipid", + "name": "publicip", + "type": "string" + }, + { + "description": "the range of ips to allocate to the clients", + "name": "iprange", + "type": "string" + }, + { + "description": "the id of the remote access vpn", + "name": "id", "type": "string" } ] @@ -83419,27 +89527,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": "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" } ] }, @@ -83458,12 +89566,12 @@ } ], "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -83488,19 +89596,19 @@ "name": "createServiceInstance", "params": [ { - "description": "The left (inside) network for service instance", + "description": "The right (outside) network ID for the service instance", "length": 255, - "name": "leftnetworkid", + "name": "rightnetworkid", "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" }, { - "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "Availability zone for the service instance", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, "type": "uuid" }, { @@ -83512,35 +89620,43 @@ "type": "uuid" }, { - "description": "Availability zone for the service instance", + "description": "The left (inside) network for service instance", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "leftnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" }, { - "description": "The right (outside) network ID for the service instance", + "description": "Project ID for the service instance", "length": 255, - "name": "rightnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, "type": "uuid" }, { - "description": "The service offering ID that defines the resources consumed by the service appliance", + "description": "The name of the service instance", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "name", "required": true, + "type": "string" + }, + { + "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, "type": "uuid" }, { - "description": "The name of the service instance", + "description": "The service offering ID that defines the resources consumed by the service appliance", "length": 255, - "name": "name", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, - "type": "string" + "type": "uuid" }, { "description": "An optional account for the virtual machine. Must be used with domainId.", @@ -83548,47 +89664,30 @@ "name": "account", "required": false, "type": "string" - }, - { - "description": "Project ID for the service instance", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" } ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "the project name of the vm", - "name": "project", + "description": "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", "type": "string" }, { - "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": "the name of the virtual machine", - "name": "name", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { @@ -83596,20 +89695,29 @@ "name": "id", "type": "string" }, - {}, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, { "description": "the account associated with the virtual machine", "name": "account", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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 domain in which the virtual machine exists", + "name": "domainid", "type": "string" } ] @@ -83629,28 +89737,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": "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" + } ] }, { @@ -83658,21 +89766,6 @@ "isasync": false, "name": "listNetscalerLoadBalancerNetworks", "params": [ - { - "description": "netscaler load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter", - "required": true, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -83686,165 +89779,179 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter", + "required": true, + "type": "uuid" } ], "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, { "description": "true if network is system, false otherwise", "name": "issystem", "type": "boolean" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "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 domain name of the network owner", - "name": "domain", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, + {}, { "description": "the type of the network", "name": "type", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the name of the network", - "name": "name", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the network domain", - "name": "networkdomain", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { @@ -83853,277 +89960,323 @@ "type": "resourceiconresponse" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the first DNS for the network", - "name": "dns1", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "true network requires restart", - "name": "restartrequired", + "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": "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": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "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": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + {}, { "description": "state of the network", "name": "state", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the list of services", - "name": "service", + "description": "the list of resource tags associated with network", + "name": "tags", "response": [ { - "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": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - } - ], - "type": "list" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the service name", - "name": "name", + "description": "tag key name", + "name": "key", "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": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "list" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { "description": "Broadcast domain type of the network", @@ -84131,30 +90284,54 @@ "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "zone id of the network", + "name": "zoneid", "type": "string" + } + ] + }, + { + "description": "create Tungsten-Fabric public network", + "isasync": false, + "name": "createTungstenFabricPublicNetwork", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "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 network", - "name": "associatednetwork", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -84174,55 +90351,48 @@ "related": "migrateSystemVm", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "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", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { @@ -84231,143 +90401,155 @@ "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, + {}, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the 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 name of the system VM", + "name": "name", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "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 public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "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 last disconnected date of host", + "name": "disconnected", + "type": "date" + }, { "description": "the hypervisor on which the template runs", "name": "hypervisor", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "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 date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the second DNS for the system VM", + "name": "dns2", + "type": "string" }, { - "description": "the 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 public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "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 link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, + {}, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" } ] @@ -84378,25 +90560,25 @@ "name": "listNetworkIsolationMethods", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", @@ -84406,17 +90588,17 @@ "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.2.0" @@ -84430,18 +90612,13 @@ "description": "List by host ID", "length": 255, "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" } ], "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", "response": [ - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -84453,56 +90630,161 @@ "type": "hastate" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the host", + "name": "hostid", "type": "string" }, + {}, { "description": "operation status", "name": "status", "type": "boolean" }, + {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "the host HA provider", + "name": "haprovider", + "type": "string" + } + ], + "since": "4.11" + }, + { + "description": "Lists VM stats", + "isasync": false, + "name": "listVirtualMachinesUsageHistory", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "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,importUnmanagedInstance", + "required": false, + "type": "list" + }, + { + "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": "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,importUnmanagedInstance", + "required": false, + "type": "uuid" + }, + { + "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" + }, + { + "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" + } + ], + "related": "listSystemVmsUsageHistory", + "response": [ + {}, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "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": "end date to filter VM stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "", "length": 255, - "name": "enddate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" }, { - "description": "the ID of the virtual machine.", + "description": "List by keyword", "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,importUnmanagedInstance", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "start date to filter VM stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "startdate", + "name": "applicationpolicysetuuid", "required": false, - "type": "date" + "type": "string" }, { "description": "", @@ -84512,71 +90794,61 @@ "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "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,importUnmanagedInstance", - "required": false, - "type": "list" - }, - { - "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "name", + "name": "firewallpolicyuuid", "required": false, "type": "string" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ - { - "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", + "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": "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 name of the virtual machine", - "name": "name", + "description": "Tungsten-Fabric firewall policy uuid", + "name": "uuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + {}, + { + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" + }, + { + "description": "Tungsten-Fabric firewall policy name", + "name": "name", "type": "string" } - ], - "since": "4.17" + ] }, { "description": "Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host.", @@ -84587,49 +90859,128 @@ "description": "host ID", "length": 255, "name": "id", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", "response": [ { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" + }, + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "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 host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, - {}, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" + }, { "description": "GPU cards present in the host", "name": "gpugroup", @@ -84648,6 +90999,11 @@ "name": "maxheads", "type": "long" }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, { "description": "Maximum X resolution per display", "name": "maxresolutionx", @@ -84658,19 +91014,14 @@ "name": "maxvgpuperpgpu", "type": "long" }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, { "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", "name": "remainingcapacity", "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { @@ -84679,9 +91030,9 @@ "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" } ], "type": "list" @@ -84690,24 +91041,9 @@ "type": "list" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { "description": "the host's currently allocated disk size", @@ -84715,93 +91051,64 @@ "type": "long" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "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 outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, + {}, { "description": "true if the host has capability to support UEFI boot", "name": "ueficapability", "type": "boolean" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { @@ -84810,150 +91117,120 @@ "type": "boolean" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "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 Pod name of the host", - "name": "podname", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the host version", - "name": "version", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "the date and time the host was created", + "name": "created", "type": "date" }, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, { "description": "the amount of the host's CPU currently allocated in MHz", "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the ID of the host", - "name": "id", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "events available for the host", - "name": "events", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, + {}, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "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": "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 host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" } ], "since": "4.16.0.0" @@ -84964,89 +91241,97 @@ "name": "createKubernetesCluster", "params": [ { - "description": "root disk size in GB for each node", + "description": "Network in which Kubernetes cluster is to be launched", "length": 255, - "name": "noderootdisksize", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", + "description": "password for the docker image private registry", "length": 255, - "name": "externalloadbalanceripaddress", + "name": "dockerregistrypassword", "required": false, "type": "string" }, { - "description": "number of Kubernetes cluster worker nodes", + "description": "Deploy cluster for the project", "length": 255, - "name": "size", - "required": true, - "type": "long" + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" }, { - "description": "Kubernetes version with which cluster to be launched", + "description": "name of the ssh key pair used to login to the virtual machines", "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", - "required": true, - "type": "uuid" + "name": "keypair", + "required": false, + "type": "string" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "account", "required": false, + "type": "string" + }, + { + "description": "the ID of the service offering for the virtual machines in the cluster.", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" }, { - "description": "password for the docker image private registry", + "description": "URL for the docker image private registry", "length": 255, - "name": "dockerregistrypassword", + "name": "dockerregistryurl", "required": false, "type": "string" }, { - "description": "name of the ssh key pair used to login to the virtual machines", + "description": "number of Kubernetes cluster control nodes, default is 1", "length": 255, - "name": "keypair", + "name": "controlnodes", "required": false, - "type": "string" + "type": "long" }, { - "description": "name for the Kubernetes cluster", + "description": "description for the Kubernetes cluster", "length": 255, - "name": "name", + "name": "description", "required": true, "type": "string" }, { - "description": "description for the Kubernetes cluster", + "description": "number of Kubernetes cluster worker nodes", "length": 255, - "name": "description", + "name": "size", "required": true, - "type": "string" + "type": "long" }, { - "description": "URL for the docker image private registry", + "description": "root disk size in GB for each node", "length": 255, - "name": "dockerregistryurl", + "name": "noderootdisksize", "required": false, - "type": "string" + "type": "long" }, { - "description": "Deploy cluster for the project", + "description": "Kubernetes version with which cluster to be launched", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, + "name": "kubernetesversionid", + "related": "listKubernetesSupportedVersions", + "required": true, "type": "uuid" }, { - "description": "number of Kubernetes cluster control nodes, default is 1", + "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", "length": 255, - "name": "controlnodes", + "name": "masternodes", "required": false, "type": "long" }, @@ -85058,27 +91343,19 @@ "type": "string" }, { - "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "masternodes", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "long" - }, - { - "description": "the ID of the service offering for the virtual machines in the cluster.", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, "type": "uuid" }, { - "description": "Network in which Kubernetes cluster is to be launched", + "description": "name for the Kubernetes cluster", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { "description": "availability zone in which Kubernetes cluster to be launched", @@ -85089,9 +91366,9 @@ "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", "length": 255, - "name": "account", + "name": "externalloadbalanceripaddress", "required": false, "type": "string" } @@ -85099,185 +91376,185 @@ "related": "startKubernetesCluster", "response": [ { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "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": "zonename", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, + {}, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", "type": "long" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "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": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the 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", + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the 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 project name of the Kubernetes cluster", + "name": "project", "type": "string" }, - {}, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "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 ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "keypair details", + "name": "keypair", + "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" } ] @@ -85288,13 +91565,20 @@ "name": "listStorageNetworkIpRange", "params": [ { - "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. Pod uuid, if specicied and range uuid is absent, using it to search the range.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -85318,17 +91602,10 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", + "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": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,listZones", "required": false, "type": "uuid" } @@ -85336,33 +91613,35 @@ "related": "createStorageNetworkIpRange", "response": [ { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "the Pod uuid for the storage network IP range", + "name": "podid", + "type": "string" + }, + { + "description": "the 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 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 ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "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", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, { @@ -85371,8 +91650,8 @@ "type": "string" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, { @@ -85381,17 +91660,15 @@ "type": "string" }, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, - {}, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -85400,6 +91677,13 @@ "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, @@ -85407,13 +91691,6 @@ "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": [ @@ -85424,13 +91701,13 @@ }, {}, { - "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" }, { @@ -85446,13 +91723,6 @@ "isasync": true, "name": "configureVirtualRouterElement", "params": [ - { - "description": "Enabled/Disabled the service provider", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - }, { "description": "the ID of the virtual router provider", "length": 255, @@ -85460,19 +91730,20 @@ "related": "configureVirtualRouterElement,listVirtualRouterElements", "required": true, "type": "uuid" + }, + { + "description": "Enabled/Disabled the service provider", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" } ], "related": "listVirtualRouterElements", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -85480,9 +91751,15 @@ "name": "projectid", "type": "string" }, + {}, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -85491,9 +91768,9 @@ "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { "description": "the id of the router", @@ -85501,20 +91778,20 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, - { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" - }, {}, { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -85527,7 +91804,7 @@ "description": "ID of the host", "length": 255, "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } @@ -85535,42 +91812,42 @@ "related": "configureHAForHost,disableHAForHost,listHostHAProviders", "response": [ { - "description": "if host HA is enabled for the host", - "name": "haenable", + "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 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": "operation status", - "name": "status", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the host HA provider", "name": "haprovider", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + } ], "since": "4.11" }, @@ -85580,11 +91857,11 @@ "name": "migrateVolume", "params": [ { - "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.", + "description": "destination storage pool ID to migrate the volume to", "length": 255, - "name": "newdiskofferingid", - "related": "", - "required": false, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": true, "type": "uuid" }, { @@ -85603,70 +91880,177 @@ "type": "boolean" }, { - "description": "destination storage pool ID to migrate the volume to", + "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": true, + "name": "newdiskofferingid", + "related": "", + "required": false, "type": "uuid" } ], "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, { "description": "the status of the volume", "name": "status", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "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.", @@ -85674,38 +92058,44 @@ "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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 service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, + {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "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 write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { @@ -85714,74 +92104,53 @@ "type": "long" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, - {}, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { @@ -85790,23 +92159,13 @@ "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": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -85815,24 +92174,30 @@ "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, + { + "description": "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 name of the template for the virtual machine", - "name": "templatename", + "description": "state of the virtual machine", + "name": "vmstate", "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": " an alternate display text of the template for the virtual machine", @@ -85840,23 +92205,28 @@ "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "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": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { @@ -85865,13 +92235,33 @@ "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -85880,130 +92270,89 @@ "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": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" + } + ], + "since": "3.0.0" + }, + { + "description": "create Tungsten-Fabric application policy set", + "isasync": true, + "name": "createTungstenFabricApplicationPolicySet", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "Tungsten-Fabric application policy set name", + "length": 255, + "name": "name", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "name of the availability zone", - "name": "zonename", + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" }, { - "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": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, + {}, { - "description": "the project name of the vpn", - "name": "project", + "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": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "size of the disk volume", - "name": "size", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" } - ], - "since": "3.0.0" + ] }, { "description": "A command to list events.", @@ -86019,55 +92368,56 @@ "type": "string" }, { - "description": "", + "description": "the time the event was entered", "length": 255, - "name": "pagesize", + "name": "entrytime", "required": false, "type": "integer" }, { - "description": "the duration of the event", + "description": "the event type (see event types)", "length": 255, - "name": "duration", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the event", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "listEvents", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, "type": "uuid" }, { - "description": "the time the event was entered", + "description": "the ID of the event", "length": 255, - "name": "entrytime", + "name": "id", + "related": "listEvents", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the event level (INFO, WARN, ERROR)", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "level", + "name": "account", "required": false, "type": "string" }, { - "description": "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event", + "description": "List by keyword", "length": 255, - "name": "startid", - "related": "listEvents", + "name": "keyword", "required": false, - "type": "uuid" + "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 only resources belonging to the domain specified", "length": 255, - "name": "startdate", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "date" + "type": "uuid" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -86077,97 +92427,96 @@ "type": "boolean" }, { - "description": "", + "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": "page", + "name": "startid", + "related": "listEvents", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "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": "domainid", - "related": "listDomainChildren,listDomains", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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": "projectid", - "related": "activateProject,suspendProject", + "name": "enddate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the event level (INFO, WARN, ERROR)", "length": 255, - "name": "listall", + "name": "level", "required": false, - "type": "boolean" + "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": "the type of the resource associated with the event", "length": 255, - "name": "enddate", + "name": "resourcetype", "required": false, - "type": "date" + "since": "4.17.0", + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the duration of the event", "length": 255, - "name": "account", + "name": "duration", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the type of the resource associated with the event", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "resourcetype", + "name": "listall", "required": false, - "since": "4.17.0", - "type": "string" + "type": "boolean" }, { - "description": "the event type (see event types)", + "description": "", "length": 255, - "name": "type", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "the type of the resource", - "name": "resourcetype", + "description": "the name of the resource", + "name": "resourcename", "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 id of the resource", - "name": "resourceid", + "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", + "name": "username", "type": "string" }, { - "description": "whether the event is parented", - "name": "parentid", - "type": "string" + "description": "the date the event was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the event", - "name": "id", + "description": "the id of the resource", + "name": "resourceid", "type": "string" }, { @@ -86176,48 +92525,43 @@ "type": "string" }, { - "description": "the name of the account's domain", - "name": "domain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date the event was created", - "name": "created", - "type": "date" + "description": "the state of the event", + "name": "state", + "type": "state" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the type of the resource", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the resource", - "name": "resourcename", + "description": "the name of the account's domain", + "name": "domain", "type": "string" }, { - "description": "the id of the account's domain", - "name": "domainid", + "description": "whether the event is parented", + "name": "parentid", "type": "string" }, { - "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", - "name": "username", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)", - "name": "account", + "description": "the id of the account's domain", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "a brief description of the event", + "name": "description", "type": "string" }, { @@ -86232,11 +92576,16 @@ "type": "string" }, { - "description": "the state of the event", - "name": "state", - "type": "state" + "description": "the ID of the event", + "name": "id", + "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", + "type": "string" + } ] }, { @@ -86253,17 +92602,17 @@ "type": "uuid" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", "length": 255, - "name": "affinitygroupids", + "name": "affinitygroupnames", "related": "", "required": false, "type": "list" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", "length": 255, - "name": "affinitygroupnames", + "name": "affinitygroupids", "related": "", "required": false, "type": "list" @@ -86271,221 +92620,206 @@ ], "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ - { - "description": "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 group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, { "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 service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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 ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "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 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 type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "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 ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "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", + "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": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "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": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "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", + "name": "diskofferingid", + "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, + { + "description": "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 name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "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 project id of the group", - "name": "projectid", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the list of ingress rules associated with the security group", @@ -86496,14 +92830,34 @@ "name": "icmpcode", "type": "integer" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -86511,8 +92865,8 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -86526,13 +92880,13 @@ "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" }, { @@ -86541,86 +92895,51 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" } ], "type": "set" }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, { "description": "the name of the security group", "name": "name", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "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", @@ -86631,18 +92950,13 @@ "name": "egressrule", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "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" }, { @@ -86651,8 +92965,13 @@ "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -86661,8 +92980,8 @@ "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -86670,8 +92989,8 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -86680,33 +92999,33 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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 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": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -86715,150 +93034,154 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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 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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the ID of the availablility 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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the 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 name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the security group", "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the description of the security group", + "name": "description", "type": "string" } ], "type": "set" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, - {}, { - "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 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" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -86867,221 +93190,109 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, - {}, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "id of the resource", + "name": "resourceid", "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 domain name of the affinity group", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name of the affinity group", + "description": "the project name where tag belongs to", "name": "project", "type": "string" } ], "type": "set" }, - { - "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": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the 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 date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the ID of 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 used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - {}, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -87089,14 +93300,19 @@ "name": "extradhcpoption", "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 netmask of the nic", - "name": "netmask", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -87105,8 +93321,8 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -87120,14 +93336,9 @@ "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", + "type": "string" }, { "description": "ID of the VLAN/VNI if available", @@ -87135,48 +93346,48 @@ "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the type of the nic", + "name": "type", "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": "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", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ID of the corresponding network", + "name": "networkid", "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 ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -87185,52 +93396,235 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" } ], "type": "set" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "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 group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "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": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the 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 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": "the name of the virtual machine", "name": "name", "type": "string" }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + {}, + { + "description": "the 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 userdata used for the VM", + "name": "userdataid", + "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": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, { "description": "public IP address id associated with vm via Static nat rule", "name": "publicipid", "type": "string" }, + {}, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + {}, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "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" } ] }, @@ -87249,42 +93643,42 @@ ], "related": "configureHAForHost,disableHAForHost", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, + {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, + {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { "description": "operation status", "name": "status", "type": "boolean" }, - {}, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.11" @@ -87295,16 +93689,16 @@ "name": "registerNetscalerServicePackage", "params": [ { - "description": "Name of the service Package.", + "description": "Description of Service Package", "length": 255, - "name": "name", + "name": "description", "required": true, "type": "string" }, { - "description": "Description of Service Package", + "description": "Name of the service Package.", "length": 255, - "name": "description", + "name": "name", "required": true, "type": "string" } @@ -87316,10 +93710,11 @@ "name": "description", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Service Package Name", + "name": "name", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -87327,16 +93722,15 @@ "type": "string" }, {}, - {}, - { - "description": "Service Package Name", - "name": "name", - "type": "string" - }, { "description": "Service Package UUID", "name": "id", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -87345,20 +93739,6 @@ "isasync": true, "name": "createTags", "params": [ - { - "description": "Map of tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": true, - "type": "map" - }, - { - "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, @@ -87372,101 +93752,27 @@ "name": "resourceids", "required": true, "type": "list" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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.0.0" - }, - { - "description": "Configures a SRX firewall device", - "isasync": true, - "name": "configureSrxFirewall", - "params": [ - { - "description": "SRX firewall device ID", + "description": "Map of tags (key/value pairs)", "length": 255, - "name": "fwdeviceid", - "related": "configureSrxFirewall", + "name": "tags", "required": true, - "type": "uuid" + "type": "map" }, { - "description": "capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", + "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", "length": 255, - "name": "fwdevicecapacity", + "name": "customer", "required": false, - "type": "long" + "type": "string" } ], - "related": "", "response": [ { - "description": "the physical network to which this SRX firewall belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the usage interface of the external firewall", - "name": "usageinterface", - "type": "string" - }, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "device name", - "name": "fwdevicename", - "type": "string" - }, - { - "description": "device id of the SRX firewall", - "name": "fwdeviceid", - "type": "string" - }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" - }, - { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", - "type": "string" - }, - { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, - { - "description": "the private security zone of the external firewall", - "name": "privatezone", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -87474,48 +93780,19 @@ "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "type": "string" - }, - { - "description": "device state", - "name": "fwdevicestate", - "type": "string" - }, - {}, - { - "description": "the username that's used to log in to the external firewall", - "name": "username", - "type": "string" - }, - { - "description": "the public interface of the external firewall", - "name": "publicinterface", - "type": "string" - }, - { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, - { - "description": "the public security zone of the external firewall", - "name": "publiczone", - "type": "string" - } - ] + {} + ], + "since": "4.0.0" }, { "description": "Create an Internal Load Balancer element.", @@ -87534,15 +93811,16 @@ "related": "configureInternalLoadBalancerElement", "response": [ { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -87555,11 +93833,10 @@ }, {}, { - "description": "the id of the internal load balancer element", - "name": "id", - "type": "string" - }, - {} + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" + } ], "since": "4.2.0" }, @@ -87579,8 +93856,8 @@ "related": "", "response": [ { - "description": "The client certificate", - "name": "certificate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -87589,22 +93866,22 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "The CA certificate(s)", - "name": "cacertificates", - "type": "string" - }, { "description": "Private key for the certificate", "name": "privatekey", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The client certificate", + "name": "certificate", "type": "string" }, - {} + { + "description": "The CA certificate(s)", + "name": "cacertificates", + "type": "string" + } ], "since": "4.11.0" }, @@ -87623,27 +93900,27 @@ } ], "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, + {}, { - "description": "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" } ] }, @@ -87668,21 +93945,21 @@ "type": "string" }, {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -87692,56 +93969,56 @@ "name": "provisionTemplateDirectDownloadCertificate", "params": [ { - "description": "the host to provision the certificate", + "description": "the id of the direct download certificate to provision", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "name": "id", + "related": "uploadTemplateDirectDownloadCertificate", "required": true, "type": "uuid" }, { - "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": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], "related": "", "response": [ - { - "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 ID of the host", + "name": "hostid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "indicates the details in case of failure or host skipped", + "name": "details", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "the name of the host", + "name": "hostname", "type": "string" - } + }, + {} ], "since": "4.17.0" }, @@ -87750,13 +94027,6 @@ "isasync": true, "name": "generateAlert", "params": [ - { - "description": "Type of the alert", - "length": 255, - "name": "type", - "required": true, - "type": "short" - }, { "description": "Pod id for which alert is generated", "length": 255, @@ -87765,6 +94035,20 @@ "required": false, "type": "uuid" }, + { + "description": "Alert description", + "length": 999, + "name": "description", + "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, @@ -87773,13 +94057,6 @@ "required": false, "type": "uuid" }, - { - "description": "Alert description", - "length": 999, - "name": "description", - "required": true, - "type": "string" - }, { "description": "Name of the alert", "length": 255, @@ -87790,6 +94067,11 @@ ], "response": [ {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -87800,16 +94082,11 @@ "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ], "since": "4.3" @@ -87819,6 +94096,13 @@ "isasync": false, "name": "updateProjectRole", "params": [ + { + "description": "creates a project role with this unique name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "The description of the Project role", "length": 255, @@ -87841,47 +94125,40 @@ "related": "updateProjectRole", "required": true, "type": "uuid" - }, - { - "description": "creates a project role with this unique name", - "length": 255, - "name": "name", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "the id of the project", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the role", + "name": "description", "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "the id of the project", + "name": "projectid", "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 ID of the role", - "name": "id", + "description": "the name of the role", + "name": "name", "type": "string" } ], @@ -87901,49 +94178,49 @@ "type": "uuid" }, { - "description": "Hostname", + "description": "Port", "length": 255, - "name": "hostname", + "name": "port", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Port", + "description": "Hostname", "length": 255, - "name": "port", + "name": "hostname", "required": true, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "linked domain", + "name": "domainid", "type": "string" }, + {}, { "description": "name of the host running the ldap server", "name": "hostname", "type": "string" }, + {}, + { + "description": "port teh 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": "linked domain", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "port teh ldap server is running on", - "name": "port", - "type": "int" - }, - {} + } ], "since": "4.2.0" }, @@ -87953,18 +94230,18 @@ "name": "ldapConfig", "params": [ { - "description": "Enter the path to trust certificates store.", + "description": "Enter the password.", "length": 255, - "name": "truststore", + "name": "bindpass", "required": false, "type": "string" }, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", + "description": "Specify the LDAP port if required, default is 389.", "length": 255, - "name": "searchbase", + "name": "port", "required": false, - "type": "string" + "type": "integer" }, { "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", @@ -87974,9 +94251,9 @@ "type": "boolean" }, { - "description": "Enter the password for trust store.", + "description": "Specify the distinguished name of a user with the search permission on the directory.", "length": 255, - "name": "truststorepass", + "name": "binddn", "required": false, "type": "string" }, @@ -87988,37 +94265,37 @@ "type": "boolean" }, { - "description": "Specify the LDAP port if required, default is 389.", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", "length": 255, - "name": "port", + "name": "searchbase", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory.", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", "length": 255, - "name": "binddn", + "name": "queryfilter", "required": false, "type": "string" }, { - "description": "Enter the password.", + "description": "Enter the password for trust store.", "length": 255, - "name": "bindpass", + "name": "truststorepass", "required": false, "type": "string" }, { - "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" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "description": "Enter the path to trust certificates store.", "length": 255, - "name": "hostname", + "name": "truststore", "required": false, "type": "string" } @@ -88031,42 +94308,42 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "DN password", + "name": "bindpass", "type": "string" }, + {}, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", "type": "string" }, { - "description": "DN password", - "name": "bindpass", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", + "name": "searchbase", "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, + {}, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", - "name": "searchbase", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", "type": "string" }, - {}, { "description": "Specify the LDAP port if required, default is 389", "name": "port", @@ -88092,19 +94369,14 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" }, { @@ -88113,21 +94385,26 @@ "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the name of the Storage Policy", "name": "name", "type": "string" - } + }, + { + "description": "the ID of the Zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", + "type": "string" + }, + {} ] }, { @@ -88145,27 +94422,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", + "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" } ] }, @@ -88174,14 +94451,6 @@ "isasync": true, "name": "migrateVPC", "params": [ - { - "description": "the ID of the vpc", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" - }, { "description": "vpc offering ID", "length": 255, @@ -88191,11 +94460,12 @@ "type": "uuid" }, { - "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", + "description": "the ID of the vpc", "length": 255, - "name": "tiernetworkofferings", - "required": false, - "type": "map" + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" }, { "description": "true if previous network migration cmd failed", @@ -88203,28 +94473,51 @@ "name": "resume", "required": false, "type": "boolean" + }, + { + "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", + "length": 255, + "name": "tiernetworkofferings", + "required": false, + "type": "map" } ], "related": "createVPC,listVPCs,updateVPC", "response": [ { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the project name of the VPC", + "name": "project", + "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 first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { @@ -88232,59 +94525,48 @@ "name": "jobid", "type": "string" }, - {}, { "description": "The routes for the network to ease adding route in upstream router", "name": "ip6routes", "type": "set" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { "description": "vpc offering name the VPC is created from", "name": "vpcofferingname", "type": "string" }, - { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", - "type": "string" - }, { "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -88293,18 +94575,18 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -88316,13 +94598,18 @@ "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" } ], "type": "list" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { @@ -88331,14 +94618,87 @@ "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "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": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the 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", @@ -88349,23 +94709,13 @@ "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", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", "type": "string" }, { @@ -88374,36 +94724,24 @@ "type": "boolean" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" }, { - "description": "the capability value", - "name": "value", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the capability name", - "name": "name", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], "type": "list" @@ -88411,11 +94749,6 @@ ], "type": "list" }, - { - "description": "the id of the VPC", - "name": "id", - "type": "string" - }, { "description": "the name of the VPC", "name": "name", @@ -88427,29 +94760,102 @@ "type": "boolean" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" + }, + { + "description": "the cidr the VPC", + "name": "cidr", + "type": "string" + }, + { + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" + } + ], + "since": "4.11.0" + }, + { + "description": "Deletes a global load balancer rule.", + "isasync": true, + "name": "deleteGlobalLoadBalancerRule", + "params": [ + { + "description": "the ID of the global load balancer rule", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "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": "update an annotation visibility.", + "isasync": false, + "name": "updateAnnotationVisibility", + "params": [ + { + "description": "the annotation is visible for admins only", + "length": 255, + "name": "adminsonly", + "required": true, "type": "boolean" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the id of the annotation", + "length": 255, + "name": "id", + "required": true, + "type": "string" + } + ], + "related": "removeAnnotation", + "response": [ + { + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { @@ -88458,173 +94864,157 @@ "type": "integer" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", + "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - } - ], - "since": "4.11.0" - }, - { - "description": "Deletes a global load balancer rule.", - "isasync": true, - "name": "deleteGlobalLoadBalancerRule", - "params": [ + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" + }, { - "description": "the ID of the global load balancer rule", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "True if the annotation is available for admins only", + "name": "adminsonly", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, {}, - { - "description": "the current status of the latest async job 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.16" }, { - "description": "update an annotation visibility.", - "isasync": false, - "name": "updateAnnotationVisibility", + "description": "create Tungsten-Fabric address group", + "isasync": true, + "name": "createTungstenFabricAddressGroup", "params": [ { - "description": "the id of the annotation", + "description": "Tungsten-Fabric ip prefix length", "length": 255, - "name": "id", + "name": "ipprefixlen", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the annotation is visible for admins only", + "description": "the ID of zone", "length": 255, - "name": "adminsonly", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "boolean" - } - ], - "related": "removeAnnotation", - "response": [ - {}, - { - "description": "the contents of the annotation", - "name": "annotation", - "type": "string" + "type": "uuid" }, { - "description": "the (uu)id of the entitiy to which this annotation pertains", - "name": "entityid", + "description": "Tungsten-Fabric address group name", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the name of the entitiy to which this annotation pertains", - "name": "entityname", + "description": "Tungsten-Fabric ip prefix", + "length": 255, + "name": "ipprefix", + "required": true, "type": "string" - }, + } + ], + "related": "", + "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 address group name", + "name": "name", + "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" - }, - { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ], - "since": "4.16" + ] }, { "description": "Lists BigSwitch BCF Controller devices", "isasync": false, "name": "listBigSwitchBcfDevices", "params": [ + { + "description": "bigswitch BCF controller device ID", + "length": 255, + "name": "bcfdeviceid", + "related": "listBigSwitchBcfDevices", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "bigswitch BCF controller device ID", + "description": "", "length": 255, - "name": "bcfdeviceid", - "related": "listBigSwitchBcfDevices", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -88640,40 +95030,18 @@ "related": "createPhysicalNetwork", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "", "response": [ - { - "description": "the controller username", - "name": "username", - "type": "string" - }, - { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", - "type": "string" - }, - { - "description": "the controller Ip address", - "name": "hostname", - "type": "string" - }, { "description": "device name", "name": "bigswitchdevicename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the controller username", + "name": "username", "type": "string" }, { @@ -88681,26 +95049,41 @@ "name": "nat", "type": "boolean" }, - {}, + { + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", + "type": "string" + }, { "description": "name of the provider", "name": "provider", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", + "type": "string" + }, { "description": "the controller password", "name": "password", "type": "string" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "the controller Ip address", + "name": "hostname", "type": "string" } ], @@ -88712,48 +95095,41 @@ "name": "updateConfiguration", "params": [ { - "description": "the name of the configuration", - "length": 255, - "name": "name", - "required": true, + "description": "the value of the configuration", + "length": 4096, + "name": "value", + "required": false, "type": "string" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "the ID of the Domain to update the parameter value for corresponding domain", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, - "name": "imagestoreuuid", - "related": "listSwifts,addImageStoreS3,listImageStores", + "name": "accountid", + "related": "enableAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, { - "description": "the value of the configuration", - "length": 4096, - "name": "value", - "required": false, - "type": "string" - }, - { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, "type": "uuid" }, @@ -88766,24 +95142,52 @@ "type": "uuid" }, { - "description": "the ID of the Domain to update the parameter value for corresponding domain", + "description": "the name of the configuration", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "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" } ], "related": "", "response": [ + { + "description": "the type of the configuration value", + "name": "type", + "type": "string" + }, + { + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" + }, + {}, + { + "description": "the category of the configuration", + "name": "category", + "type": "string" + }, + { + "description": "the subgroup of the configuration", + "name": "subgroup", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the category of the configuration", - "name": "category", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { @@ -88796,6 +95200,11 @@ "name": "description", "type": "string" }, + { + "description": "the value of the configuration", + "name": "id", + "type": "long" + }, { "description": "the value of the configuration", "name": "value", @@ -88807,22 +95216,36 @@ "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the name of the parent configuration", + "name": "parent", + "type": "string" + }, + { + "description": "the component of the configuration", + "name": "component", + "type": "string" + }, + { + "description": "the group of the configuration", + "name": "group", + "type": "string" + }, + { + "description": "the default value of the configuration", + "name": "defaultvalue", + "type": "string" + }, + { + "description": "the display text of the configuration", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, - { - "description": "the value of the configuration", - "name": "id", - "type": "long" - } + {} ] }, { @@ -88831,29 +95254,27 @@ "name": "configureHAForHost", "params": [ { - "description": "ID of the host", + "description": "HA provider", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "name": "provider", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "HA provider", + "description": "ID of the host", "length": 255, - "name": "provider", + "name": "hostid", + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", "required": true, - "type": "string" + "type": "uuid" } ], "related": "disableHAForHost", "response": [ - {}, - {}, { - "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 host HA provider", @@ -88865,49 +95286,132 @@ "name": "status", "type": "boolean" }, - { - "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 ID of the host", - "name": "hostid", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + {} ], "since": "4.11" }, { - "description": "Dedicates a Public IP range to an account", + "description": "Lists volume stats", "isasync": false, - "name": "dedicatePublicIpRange", + "name": "listVolumesUsageHistory", "params": [ { - "description": "the id of the VLAN IP range", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + }, + { + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, + { + "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the IDs of the volumes, mutually exclusive with id.", + "length": 255, + "name": "ids", + "related": "migrateSystemVm", + "required": false, + "type": "list" + }, + { + "description": "the ID of the volume.", "length": 255, "name": "id", - "related": "dedicatePublicIpRange", - "required": true, + "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": false, "type": "uuid" }, { - "description": "account who will own the VLAN", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {}, + { + "description": "the name of the volume", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the volume", + "name": "id", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the list of VM stats", + "name": "stats", + "type": "list" + } + ], + "since": "4.18.0" + }, + { + "description": "Dedicates a Public IP range to an account", + "isasync": false, + "name": "dedicatePublicIpRange", + "params": [ { "description": "domain ID of the account owning a VLAN", "length": 255, @@ -88923,43 +95427,69 @@ "related": "activateProject,suspendProject", "required": false, "type": "uuid" + }, + { + "description": "the id of the VLAN IP range", + "length": 255, + "name": "id", + "related": "dedicatePublicIpRange", + "required": true, + "type": "uuid" + }, + { + "description": "account who will own the VLAN", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "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 netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", + "type": "string" + }, + {}, + { + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { @@ -88968,70 +95498,74 @@ "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "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 Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the description of the VLAN IP range", "name": "description", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" - }, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", + "type": "string" }, - {}, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { @@ -89043,21 +95577,6 @@ "description": "the project id of the vlan range", "name": "projectid", "type": "string" - }, - { - "description": "the end ip of the VLAN IP range", - "name": "endip", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain name of the VLAN IP range", - "name": "domain", - "type": "string" } ] }, @@ -89067,12 +95586,11 @@ "name": "createProjectRolePermission", "params": [ { - "description": "ID of project where project role permission is to be created", + "description": "The rule permission, allow or deny. Default: deny.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "permission", "required": true, - "type": "uuid" + "type": "string" }, { "description": "The description of the role permission", @@ -89082,11 +95600,12 @@ "type": "string" }, { - "description": "The rule permission, allow or deny. Default: deny.", + "description": "ID of project where project role permission is to be created", "length": 255, - "name": "permission", + "name": "projectid", + "related": "activateProject,suspendProject", "required": true, - "type": "string" + "type": "uuid" }, { "description": "The API name or wildcard rule such as list*", @@ -89111,46 +95630,46 @@ "name": "permission", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the ID of the project role permission", "name": "id", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the ID of the project", + "name": "projectid", "type": "string" }, + {}, { "description": "the name of the project role to which the role permission belongs", "name": "projectrolename", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the project", - "name": "projectid", + "description": "the description of the role permission", + "name": "description", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" } ], @@ -89171,48 +95690,106 @@ { "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": "Description of Service Package", + "name": "description", + "type": "string" + }, { "description": "Service Package Name", "name": "name", "type": "string" }, { - "description": "Description of Service Package", - "name": "description", + "description": "Service Package UUID", + "name": "id", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Create a console endpoint to connect to a VM console", + "isasync": false, + "name": "createConsoleEndpoint", + "params": [ { - "description": "Service Package UUID", - "name": "id", + "description": "(optional) extra security token, valid when the extra validation is enabled", + "length": 255, + "name": "token", + "required": false, "type": "string" }, + { + "description": "ID of the VM", + "length": 255, + "name": "virtualmachineid", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ {}, - {} - ] + {}, + { + "description": "the console url", + "name": "url", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the console endpoint is generated properly", + "name": "success", + "type": "boolean" + }, + { + "description": "details in case of an error", + "name": "details", + "type": "string" + }, + { + "description": "the console websocket options", + "name": "websocket", + "type": "consoleendpointwebsocketresponse" + } + ], + "since": "4.18.0" }, { "description": "Updates a project role permission and/or order", @@ -89220,11 +95797,19 @@ "name": "updateProjectRolePermission", "params": [ { - "description": "ID of the project role", + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "length": 255, - "name": "projectroleid", + "name": "ruleorder", "related": "", - "required": true, + "required": false, + "type": "list" + }, + { + "description": "Project Role permission rule id", + "length": 255, + "name": "projectrolepermissionid", + "related": "", + "required": false, "type": "uuid" }, { @@ -89235,11 +95820,11 @@ "type": "string" }, { - "description": "Project Role permission rule id", + "description": "ID of the project role", "length": 255, - "name": "projectrolepermissionid", + "name": "projectroleid", "related": "", - "required": false, + "required": true, "type": "uuid" }, { @@ -89249,17 +95834,20 @@ "related": "activateProject,suspendProject", "required": true, "type": "uuid" - }, - { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", - "length": 255, - "name": "ruleorder", - "related": "", - "required": false, - "type": "list" } ], "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", @@ -89270,17 +95858,6 @@ "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" @@ -89290,13 +95867,6 @@ "isasync": false, "name": "enableStaticNat", "params": [ - { - "description": "VM guest NIC secondary IP address for the port forwarding rule", - "length": 255, - "name": "vmguestip", - "required": false, - "type": "string" - }, { "description": "the public IP address ID for which static NAT feature is being enabled", "length": 255, @@ -89305,6 +95875,13 @@ "required": true, "type": "uuid" }, + { + "description": "VM guest NIC secondary IP address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, + "type": "string" + }, { "description": "the ID of the virtual machine for enabling static NAT feature", "length": 255, @@ -89323,23 +95900,23 @@ } ], "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", @@ -89368,6 +95945,11 @@ "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -89378,11 +95960,6 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -89392,17 +95969,17 @@ "name": "addUserToProject", "params": [ { - "description": "email ID of user to which invitation to the project is going to be sent", + "description": "Name of the user to be added to the project", "length": 255, - "name": "email", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "Name of the user to be added to the project", + "description": "email ID of user to which invitation to the project is going to be sent", "length": 255, - "name": "username", - "required": true, + "name": "email", + "required": false, "type": "string" }, { @@ -89430,27 +96007,27 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.14" @@ -89470,16 +96047,16 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -89487,13 +96064,59 @@ "type": "integer" }, {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.11" + }, + { + "description": "delete Tungsten-Fabric firewall policy", + "isasync": true, + "name": "deleteTungstenFabricFirewallPolicy", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ], - "since": "4.11" + ] }, { "description": "Recovers a virtual machine.", @@ -89512,579 +96135,471 @@ "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "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", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "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 name of the virtual machine", "name": "group", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "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": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, - {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, { "description": "the name of the template for the virtual machine", "name": "templatename", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, + {}, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "the name of the ISO attached to the virtual machine", "name": "isoname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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 ID of the host for the virtual machine", - "name": "hostid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the account owning the security group", - "name": "account", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the project name of the group", - "name": "project", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "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 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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the 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 IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the 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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "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", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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 ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" } ], "type": "set" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "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" }, { @@ -90093,343 +96608,481 @@ "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Base64 string containing the user data", + "name": "userdata", "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": "publicip", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, - {}, { - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "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 VM's disk read in KiB", - "name": "diskkbsread", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the 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 vGPU type used by the virtual machine", + "name": "vgpu", + "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "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 type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "the 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 the backup offering of the virtual machine", + "name": "backupofferingid", + "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the 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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the nic", + "description": "the ID of the security group", "name": "id", "type": "string" }, { - "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the 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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "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 (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "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", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { @@ -90437,39 +97090,54 @@ "name": "project", "type": "string" }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, { "description": "true if high-availability is enabled, false otherwise", "name": "haenable", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the pool type of the virtual machine", + "name": "pooltype", "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" } ] @@ -90480,46 +97148,24 @@ "name": "getUploadParamsForTemplate", "params": [ { - "description": "32 or 64 bits support. 64 by default", - "length": 255, - "name": "bits", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", + "description": "the ID of the zone the volume/template is to be hosted on", "length": 255, - "name": "ostypeid", - "related": "", - "required": false, + "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 or its derivatives are extractable; default is false", "length": 255, - "name": "passwordenabled", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, - "type": "string" - }, - { - "description": "Upload volume/template for the project", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, - { - "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", "required": true, "type": "string" }, @@ -90546,39 +97192,46 @@ "type": "boolean" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "the name of the volume/template", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "isfeatured", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "name": "format", + "required": true, + "type": "string" }, { - "description": "the name of the volume/template", + "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 is to be hosted on", + "description": "the checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", 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,listZones", - "required": true, + "name": "checksum", + "required": false, + "type": "string" + }, + { + "description": "Upload volume/template for the project", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, "type": "uuid" }, { @@ -90589,40 +97242,32 @@ "type": "boolean" }, { - "description": "the checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "checksum", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the target hypervisor for the template", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - }, - { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "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": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "the tag for this template.", "length": 255, - "name": "deployasis", + "name": "templatetag", "required": false, - "since": "4.15.1", - "type": "boolean" + "type": "string" }, { "description": "true if this template requires HVM", @@ -90637,18 +97282,36 @@ "name": "sshkeyenabled", "required": false, "type": "boolean" + }, + { + "description": "32 or 64 bits support. 64 by default", + "length": 255, + "name": "bits", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", + "length": 255, + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "length": 255, + "name": "deployasis", + "required": false, + "since": "4.15.1", + "type": "boolean" } ], "related": "getUploadParamsForIso", "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": "signature to be sent in the POST request.", + "name": "signature", "type": "string" }, { @@ -90657,13 +97320,8 @@ "type": "url" }, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" - }, - { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -90673,8 +97331,18 @@ }, {}, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "the template/volume ID", + "name": "id", + "type": "uuid" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" }, {} @@ -90696,67 +97364,206 @@ } ], "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.17.0" }, { - "description": "Release the dedication for host", + "description": "update Tungsten-Fabric loadbalancer health monitor", "isasync": true, - "name": "releaseDedicatedHost", + "name": "updateTungstenFabricLBHealthMonitor", "params": [ { - "description": "the ID of the host", + "description": "loadbalancer health monitor url path", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "name": "urlpath", + "required": false, + "type": "string" + }, + { + "description": "loadbalancer health monitor http method", + "length": 255, + "name": "httpmethodtype", + "required": false, + "type": "string" + }, + { + "description": "loadbalancer health monitor timeout", + "length": 255, + "name": "timeout", + "required": true, + "type": "integer" + }, + { + "description": "loadbalancer health monitor expected code", + "length": 255, + "name": "expectedcode", + "required": false, + "type": "string" + }, + { + "description": "loadbalancer health monitor type", + "length": 255, + "name": "type", + "required": true, + "type": "string" + }, + { + "description": "loadbalancer health monitor retry", + "length": 255, + "name": "retry", + "required": true, + "type": "integer" + }, + { + "description": "the ID of lb rule", + "length": 255, + "name": "lbruleid", + "related": "updateIpv6FirewallRule", "required": true, "type": "uuid" + }, + { + "description": "loadbalancer health monitor interval", + "length": 255, + "name": "interval", + "required": true, + "type": "integer" } ], + "related": "", "response": [ + { + "description": "the health monitor http method", + "name": "httpmethod", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the health monitor type", + "name": "type", + "type": "string" + }, + { + "description": "the health monitor timeout", + "name": "timeout", + "type": "int" + }, + {}, + { + "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 ID", + "name": "id", + "type": "long" + }, + { + "description": "the health monitor url path", + "name": "urlpath", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the health monitor retry", + "name": "retry", + "type": "int" + }, {}, - {}, + { + "description": "the health monitor interval", + "name": "interval", + "type": "int" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "the health monitor UUID", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + } + ] + }, + { + "description": "Release the dedication for host", + "isasync": true, + "name": "releaseDedicatedHost", + "params": [ + { + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + {}, { - "description": "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" } ] }, @@ -90766,19 +97573,11 @@ "name": "updateProjectInvitation", "params": [ { - "description": "account that is joining the project", + "description": "if true, accept the invitation, decline if false. True by default", "length": 255, - "name": "account", + "name": "accept", "required": false, - "type": "string" - }, - { - "description": "id of the project to join", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" + "type": "boolean" }, { "description": "User UUID, required for adding account from external provisioning system", @@ -90788,6 +97587,13 @@ "required": false, "type": "uuid" }, + { + "description": "account that is joining the project", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "list invitations for specified account; this parameter has to be specified with domainId", "length": 255, @@ -90796,31 +97602,32 @@ "type": "string" }, { - "description": "if true, accept the invitation, decline if false. True by default", + "description": "id of the project to join", "length": 255, - "name": "accept", - "required": false, - "type": "boolean" + "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": "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", @@ -90846,33 +97653,28 @@ "related": "", "response": [ { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { @@ -90881,8 +97683,8 @@ "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, {}, @@ -90892,33 +97694,33 @@ "type": "boolean" }, { - "description": "name of the snapshot", - "name": "name", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { @@ -90927,43 +97729,27 @@ "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": "id of the availability zone", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -90972,69 +97758,144 @@ "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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "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": "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": "set" }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" + }, { "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", "name": "revertable", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" + "description": "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": "Updates a condition for VM auto scaling", + "isasync": true, + "name": "updateCondition", + "params": [ + { + "description": "the ID of the condition.", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "Value for which the Counter will be evaluated with the Operator selected.", + "length": 255, + "name": "threshold", + "required": true, + "type": "long" + }, + { + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "length": 255, + "name": "relationaloperator", + "required": true, + "type": "string" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ], + "since": "4.18.0" + }, { "description": "Lists Regions", "isasync": false, "name": "listRegions", "params": [ { - "description": "List Region by region ID.", + "description": "", "length": 255, - "name": "id", + "name": "pagesize", "required": false, "type": "integer" }, @@ -91046,29 +97907,50 @@ "type": "string" }, { - "description": "", + "description": "List Region by region ID.", "length": 255, - "name": "pagesize", + "name": "id", "required": false, "type": "integer" }, { - "description": "", + "description": "List Region by region name.", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List Region by region name.", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "addRegion", "response": [ + { + "description": "the ID of the region", + "name": "id", + "type": "integer" + }, + { + "description": "the end point of the region", + "name": "endpoint", + "type": "string" + }, + { + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if security groups support is enabled, false otherwise", "name": "portableipserviceenabled", @@ -91079,48 +97961,72 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the ID of the region", - "name": "id", - "type": "integer" - }, + {}, { "description": "the name of the region", "name": "name", "type": "string" - }, - {}, - {}, + } + ] + }, + { + "description": "Configures an Internal Load Balancer element.", + "isasync": true, + "name": "configureInternalLoadBalancerElement", + "params": [ { - "description": "the end point of the region", - "name": "endpoint", - "type": "string" + "description": "Enables/Disables the Internal Load Balancer element", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" }, { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", + "description": "the ID of the internal lb provider", + "length": 255, + "name": "id", + "related": "configureInternalLoadBalancerElement", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "Enabled/Disabled the element", + "name": "enabled", "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the physical network service provider id of the element", + "name": "nspid", + "type": "string" + }, + { + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" } - ] + ], + "since": "4.2.0" }, { "description": "Attempts Migration of a system virtual machine to the host specified.", "isasync": true, "name": "migrateSystemVm", "params": [ - { - "description": "destination Host ID to migrate VM to", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", - "required": false, - "type": "uuid" - }, { "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", "length": 255, @@ -91138,6 +98044,14 @@ "required": true, "type": "uuid" }, + { + "description": "destination Host ID to migrate VM to", + "length": 255, + "name": "hostid", + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + }, { "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", "length": 255, @@ -91150,58 +98064,64 @@ "related": "", "response": [ { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, + {}, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { @@ -91210,66 +98130,69 @@ "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, - {}, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "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 ID of the system VM", - "name": "id", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, - {}, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the 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 template name for the system VM", - "name": "templatename", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "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 first DNS for the system VM", - "name": "dns1", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" + }, + { + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" }, { "description": "the hostname for the system VM", @@ -91277,79 +98200,75 @@ "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, + {}, { - "description": "the private IP address for the system VM", - "name": "privateip", + "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 link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the state of the system VM", + "name": "state", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" } ] }, { - "description": "List the counters", + "description": "List the counters for VM auto scaling", "isasync": false, "name": "listCounters", "params": [ @@ -91373,40 +98292,54 @@ "name": "id", "related": "createCounter,listCounters", "required": false, - "type": "uuid" + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "Network provider of the counter.", "length": 255, - "name": "pagesize", + "name": "provider", "required": false, - "type": "integer" + "since": "4.18.0", + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "createCounter", "response": [ { - "description": "Source of the counter.", - "name": "source", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, + {}, { - "description": "the id of the Counter", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Source of the counter.", + "name": "source", "type": "string" }, { @@ -91415,81 +98348,139 @@ "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "Name of the counter.", + "name": "name", "type": "string" }, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "the id of the Counter", + "name": "id", "type": "string" }, + {}, { - "description": "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": "Name of the counter.", - "name": "name", + "description": "Provider of the counter.", + "name": "provider", "type": "string" - }, - {}, - {} + } ] }, { - "description": "Configures an Internal Load Balancer element.", + "description": "remove Tungsten-Fabric tag", "isasync": true, - "name": "configureInternalLoadBalancerElement", + "name": "removeTungstenFabricTag", "params": [ { - "description": "Enables/Disables the Internal Load Balancer element", + "description": "the ID of zone", "length": 255, - "name": "enabled", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the internal lb provider", + "description": "the uuid of nics", "length": 255, - "name": "id", - "related": "configureInternalLoadBalancerElement", + "name": "nicuuid", + "required": false, + "type": "list" + }, + { + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, + "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": false, + "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric tag", + "length": 255, + "name": "taguuid", "required": true, - "type": "uuid" + "type": "string" + }, + { + "description": "the uuid of vms", + "length": 255, + "name": "vmuuid", + "required": false, + "type": "list" + }, + { + "description": "the uuid of networks", + "length": 255, + "name": "networkuuid", + "required": false, + "type": "list" } ], - "related": "", + "related": "createTungstenFabricTag", "response": [ { - "description": "the id of the internal load balancer element", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { - "description": "the physical network service provider id of the element", - "name": "nspid", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + { + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" + }, + { + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" + }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "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" - }, - {} - ], - "since": "4.2.0" + } + ] }, { "description": "Lists all available virtual router elements.", @@ -91497,26 +98488,18 @@ "name": "listVirtualRouterElements", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list virtual router elements by network service provider id", + "description": "", "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list network offerings by enabled state", + "description": "", "length": 255, - "name": "enabled", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "list virtual router elements by id", @@ -91527,67 +98510,75 @@ "type": "uuid" }, { - "description": "", + "description": "list network offerings by enabled state", "length": 255, - "name": "page", + "name": "enabled", "required": false, - "type": "integer" + "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", + "length": 255, + "name": "nspid", + "related": "listNetworkServiceProviders", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the project name of the address", + "name": "project", "type": "string" }, + {}, { "description": "Enabled/Disabled the service provider", "name": "enabled", "type": "boolean" }, - {}, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name of the address", - "name": "project", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, - {}, { - "description": "the account associated with the provider", - "name": "account", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { @@ -91603,37 +98594,33 @@ "name": "deleteSnapshotPolicies", "params": [ { - "description": "list of snapshots policy IDs separated by comma", + "description": "the Id of the snapshot policy", "length": 255, - "name": "ids", + "name": "id", "related": "updateSnapshotPolicy", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the Id of the snapshot policy", + "description": "list of snapshots policy IDs separated by comma", "length": 255, - "name": "id", + "name": "ids", "related": "updateSnapshotPolicy", "required": false, - "type": "uuid" + "type": "list" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", @@ -91641,7 +98628,11 @@ "type": "string" }, {}, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -91680,12 +98671,6 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, {}, { "description": "implementor of network traffic type", @@ -91693,13 +98678,19 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "network traffic type", + "name": "traffictype", "type": "string" }, + {}, { - "description": "network traffic type", - "name": "traffictype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -91710,20 +98701,6 @@ "isasync": false, "name": "linkAccountToLdap", "params": [ - { - "description": "name of the group or OU in LDAP", - "length": 255, - "name": "ldapdomain", - "required": true, - "type": "string" - }, - { - "description": "name of the account, it will be created if it does not exist", - "length": 255, - "name": "account", - "required": true, - "type": "string" - }, { "description": "The id of the domain that is to contain the linked account.", "length": 255, @@ -91733,10 +98710,10 @@ "type": "uuid" }, { - "description": "type of the ldap name. GROUP or OU, defaults to GROUP", + "description": "name of the group or OU in LDAP", "length": 255, - "name": "type", - "required": false, + "name": "ldapdomain", + "required": true, "type": "string" }, { @@ -91746,38 +98723,62 @@ "required": false, "type": "string" }, + { + "description": "name of the account, it will be created if it does not exist", + "length": 255, + "name": "account", + "required": true, + "type": "string" + }, { "description": "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": "type of the ldap name. GROUP or OU, defaults to GROUP", + "length": 255, + "name": "type", + "required": false, + "type": "string" } ], "related": "", "response": [ - { - "description": "Domain Admin accountId that is created", - "name": "accountid", - "type": "string" - }, {}, { "description": "name of the group or OU in LDAP which is linked to the domain", "name": "ldapdomain", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "Domain Admin accountId that is created", + "name": "accountid", + "type": "string" + }, + { + "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": "Type of the account to auto import", + "name": "accounttype", + "type": "int" + }, + {}, { "description": "type of the name in LDAP which is linke to the domain", "name": "type", @@ -91787,16 +98788,6 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "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" } ], "since": "4.11.0" @@ -91809,65 +98800,65 @@ "related": "", "response": [ { - "description": "the name of the active usage server", - "name": "hostname", + "description": "the version of the currently running DB", + "name": "versioncomment", "type": "string" }, { - "description": "the state of the usage server", - "name": "replicas", - "type": "string[]" + "description": "the tls versions currently in use (accepted) by the DB", + "name": "tlsversions", + "type": "string" + }, + { + "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 last measured load averages on the DB", "name": "dbloadaverages", "type": "double[]" }, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" + "description": "the number of connections to the DB", + "name": "connections", + "type": "int" }, { "description": "the uptime of the DB in seconds", "name": "uptime", - "type": "int" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "type": "long" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { "description": "the version of the currently running DB", - "name": "versioncomment", + "name": "version", "type": "string" }, { - "description": "the number of queries performed on the DB", - "name": "queries", - "type": "int" - }, - { - "description": "the number of connections to the DB", - "name": "connections", - "type": "int" + "description": "the state of the usage server", + "name": "replicas", + "type": "string[]" }, { - "description": "the version of the currently running DB", - "name": "version", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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" } ], @@ -91888,27 +98879,27 @@ } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.2.0" @@ -91919,66 +98910,63 @@ "name": "listAutoScaleVmProfiles", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the otherdeployparameters of the autoscale vm profile", "length": 255, - "name": "listall", + "name": "otherdeployparams", "required": false, - "type": "boolean" + "type": "string" }, { - "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 display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list profiles by service offering id", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { - "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": "availability zone for the auto deployed virtual machine", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "isrecursive", "required": false, - "since": "4.4", - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "keyword", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the otherdeployparameters of the autoscale vm profile", + "description": "", "length": 255, - "name": "otherdeployparams", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -91988,50 +98976,59 @@ "type": "string" }, { - "description": "", + "description": "availability zone for the auto deployed virtual machine", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "integer" + "since": "4.4", + "type": "uuid" }, { - "description": "the templateid of the autoscale vm profile", + "description": "the ID of the autoscale vm profile", "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "id", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list profiles by service offering id", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "", + "description": "the templateid of the autoscale vm profile", "length": 255, - "name": "page", + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createAutoScaleVmProfile", "response": [ { - "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 domain name of the vm profile", + "name": "domain", + "type": "string" }, { "description": "the domain ID of the vm profile", @@ -92039,55 +99036,61 @@ "type": "string" }, {}, + { + "description": "the project name of the vm profile", + "name": "project", + "type": "string" + }, + {}, { "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 service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "is profile for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the 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", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "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", + "description": "Base 64 encoded VM user data", + "name": "userdata", "type": "string" }, - {}, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { @@ -92096,17 +99099,10 @@ "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "destroyvmgraceperiod", - "type": "integer" - }, - { - "description": "the account owning the instance group", - "name": "account", - "type": "string" - }, - {}, - {} + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" + } ] }, { @@ -92118,22 +99114,16 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", "response": [ - {}, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -92142,39 +99132,39 @@ "type": "integer" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, {}, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the operation result description", + "name": "description", "type": "string" }, { @@ -92183,14 +99173,20 @@ "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", - "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 out-of-band management interface password", + "name": "password", "type": "string" + }, + {}, + { + "description": "the operation result", + "name": "status", + "type": "boolean" } ], "since": "4.9.0" @@ -92204,131 +99200,151 @@ "description": "host ID", "length": 255, "name": "id", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], - "related": "addBaremetalHost,reconnectHost", + "related": "reconnectHost,addBaremetalHost", "response": [ { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hypervisor version", + "name": "hypervisorversion", + "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 used", + "name": "memoryused", "type": "long" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "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 cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "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", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the CPU number of the host", - "name": "cpunumber", + "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's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { @@ -92337,44 +99353,48 @@ "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" + }, + { + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, - {}, { - "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 incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "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 incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { @@ -92382,58 +99402,94 @@ "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, + {}, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "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 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": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { @@ -92447,129 +99503,74 @@ "type": "string" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "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", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the 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 admin that annotated this host", - "name": "username", - "type": "string" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" - }, - { - "description": "the name of the host", - "name": "name", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, { "description": "the OS category ID of the host", "name": "oscategoryid", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "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" } ], @@ -92581,17 +99582,9 @@ "name": "authorizeSecurityGroupIngress", "params": [ { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "error code for this icmp message", + "description": "type of the icmp message being sent", "length": 255, - "name": "icmpcode", + "name": "icmptype", "required": false, "type": "integer" }, @@ -92604,18 +99597,25 @@ "type": "uuid" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.", + "description": "user to security group mapping", "length": 255, - "name": "protocol", + "name": "usersecuritygrouplist", "required": false, - "type": "string" + "type": "map" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "end port for this ingress rule", "length": 255, - "name": "securitygroupname", + "name": "endport", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" }, { "description": "start port for this ingress rule", @@ -92625,32 +99625,34 @@ "type": "integer" }, { - "description": "user to security group mapping", + "description": "an optional project of the security group", "length": 255, - "name": "usersecuritygrouplist", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "end port for this ingress rule", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "endport", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the cidr list associated. 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": "type of the icmp message being sent", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "icmptype", + "name": "securitygroupname", "required": false, - "type": "integer" + "type": "string" }, { "description": "an optional account for the security group. Must be used with domainId.", @@ -92660,29 +99662,59 @@ "type": "string" }, { - "description": "an optional project of the security group", + "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": "projectid", - "related": "activateProject,suspendProject", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the 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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -92690,18 +99722,24 @@ "name": "icmptype", "type": "integer" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + {}, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "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" }, { @@ -92710,8 +99748,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -92720,18 +99758,18 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -92740,49 +99778,12 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - {}, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -92803,39 +99804,34 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, + {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the storage pool path", - "name": "path", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { @@ -92844,59 +99840,49 @@ "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - }, - { - "description": "the 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", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "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 storage pool path", + "name": "path", + "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { "description": "the Zone name of the storage pool", @@ -92904,24 +99890,25 @@ "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { "description": "the storage pool capabilities", @@ -92929,21 +99916,35 @@ "type": "map" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the storage pool type", + "name": "type", "type": "string" }, - {} + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" + }, + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" + } ], "since": "4.15.1" }, @@ -92952,6 +99953,21 @@ "isasync": false, "name": "createSecurityGroup", "params": [ + { + "description": "name of the security group", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Create security group for project", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" + }, { "description": "an optional account for the security group. Must be used with domainId.", "length": 255, @@ -92973,283 +99989,231 @@ "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" - }, - { - "description": "name of the security group", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Create security group for project", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" } ], "related": "", "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + {}, + { + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the name of the security group", + "name": "name", "type": "string" }, - {}, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the description of the security group", + "name": "description", + "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "tag key name", + "name": "key", "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the 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 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 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 name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "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": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "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": "the project id the tag belongs to", - "name": "projectid", + "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 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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the 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 id of the security group rule", + "name": "ruleid", + "type": "string" } ], "type": "set" }, + {}, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain ID of the security group", + "name": "domainid", "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 account owning the security group", - "name": "account", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -93258,76 +100222,113 @@ "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": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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" }, { - "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "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": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -93348,51 +100349,51 @@ "related": "", "response": [ { - "description": "the network ID", - "name": "networkid", + "description": "the ID of account the network is available for", + "name": "accountid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network ID", + "name": "networkid", "type": "string" }, - {}, { - "description": "the account the network is available for", - "name": "account", + "description": "the ID of the domain to which the network belongs", + "name": "domainid", "type": "string" }, {}, { - "description": "the ID of account the network is available for", - "name": "accountid", + "description": "the name of the domain to which the network belongs", + "name": "domain", "type": "string" }, { - "description": "the ID of project the network is available for", - "name": "projectid", + "description": "the project the network is available for", + "name": "project", "type": "string" }, { - "description": "the name of the domain to which the network belongs", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account the network is available for", + "name": "account", + "type": "string" }, { - "description": "the ID of the domain to which the network belongs", - "name": "domainid", + "description": "the ID of project the network is available for", + "name": "projectid", "type": "string" }, + {}, { - "description": "the project the network is available for", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.17.0" @@ -93403,12 +100404,11 @@ "name": "updateResourceCount", "params": [ { - "description": "Update resource limits for project", + "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": "projectid", - "related": "activateProject,suspendProject", + "name": "resourcetype", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "Update resource count for a specified account. Must be used with the domainId parameter.", @@ -93417,6 +100417,14 @@ "required": false, "type": "string" }, + { + "description": "Update resource limits for project", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, + "type": "uuid" + }, { "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", "length": 255, @@ -93424,69 +100432,62 @@ "related": "listDomainChildren,listDomains", "required": true, "type": "uuid" - }, - { - "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", - "length": 255, - "name": "resourcetype", - "required": false, - "type": "integer" } ], "related": "", "response": [ - { - "description": "the account for which resource count's are updated", - "name": "account", - "type": "string" - }, - { - "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 project name for which resource count's are updated", "name": "project", "type": "string" }, { - "description": "the domain name for which resource count's are updated", - "name": "domain", + "description": "the domain ID for which resource count's are updated", + "name": "domainid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account for which resource count's are updated", + "name": "account", + "type": "string" + }, + { + "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", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id for which resource count's are updated", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID for which resource count's are updated", - "name": "domainid", + "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" - } + }, + {} ] }, { @@ -93495,34 +100496,42 @@ "name": "listVpnGateways", "params": [ { - "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" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "id of the vpn gateway", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "id of vpc", "length": 255, - "name": "pagesize", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -93533,26 +100542,33 @@ "type": "boolean" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "id of the vpn gateway", + "length": 255, + "name": "id", + "related": "createVpnGateway,listVpnGateways", "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -93560,117 +100576,194 @@ "name": "listall", "required": false, "type": "boolean" + } + ], + "related": "createVpnGateway", + "response": [ + { + "description": "the vpc name of this gateway", + "name": "vpcname", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the project id", + "name": "projectid", + "type": "string" }, + {}, + {}, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the owner", "name": "account", - "required": false, "type": "string" - } - ], - "related": "createVpnGateway", - "response": [ + }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the public IP address", "name": "publicip", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, - {}, - {}, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the project name", + "name": "project", + "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "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", + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + } + ] + }, + { + "description": "Lists dynamic roles in CloudStack", + "isasync": false, + "name": "listRoles", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "List role by role name.", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "List role by role ID.", + "length": 255, + "name": "id", + "related": "importRole,listRoles", + "required": false, + "type": "uuid" + } + ], + "related": "importRole", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the owner", - "name": "account", + "description": "the name of the role", + "name": "name", "type": "string" }, + {}, { - "description": "the project name", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the role", + "name": "description", "type": "string" }, { - "description": "the vpn gateway ID", + "description": "the ID of the role", "name": "id", "type": "string" + }, + { + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" } - ] + ], + "since": "4.9.0" }, { - "description": "Lists dynamic roles in CloudStack", + "description": "list Tungsten-Fabric policy", "isasync": false, - "name": "listRoles", + "name": "listTungstenFabricPolicy", "params": [ { - "description": "List role by role name.", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of network", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "type": "string" }, @@ -93682,26 +100775,35 @@ "type": "integer" }, { - "description": "List role by role ID.", + "description": "the ID of ip address", "length": 255, - "name": "id", - "related": "importRole,listRoles", + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "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", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" } ], - "related": "importRole", + "related": "", "response": [ + {}, { - "description": "the type of the role", - "name": "type", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { @@ -93709,35 +100811,34 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "the ID of the role", - "name": "id", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { - "description": "the name of the role", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "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": "the description of the role", - "name": "description", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" } - ], - "since": "4.9.0" + ] }, { "description": "Retrieves a cloud identifier.", @@ -93756,27 +100857,27 @@ "related": "", "response": [ { - "description": "the cloud identifier", - "name": "cloudidentifier", - "type": "string" - }, - { - "description": "the signed response for the cloud identifier", - "name": "signature", + "description": "the user ID for the cloud identifier", + "name": "userid", "type": "string" }, { - "description": "the user ID for the cloud identifier", - "name": "userid", + "description": "the cloud identifier", + "name": "cloudidentifier", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + { + "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", @@ -93790,10 +100891,10 @@ "name": "createLBStickinessPolicy", "params": [ { - "description": "name of the load balancer stickiness policy", + "description": "the description of the load balancer stickiness policy", "length": 255, - "name": "name", - "required": true, + "name": "description", + "required": false, "type": "string" }, { @@ -93805,18 +100906,11 @@ "type": "boolean" }, { - "description": "the description of the load balancer stickiness policy", + "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", "length": 255, - "name": "description", + "name": "param", "required": false, - "type": "string" - }, - { - "description": "name of the load balancer stickiness policy method, possible values can be obtained from listNetworks API", - "length": 255, - "name": "methodname", - "required": true, - "type": "string" + "type": "map" }, { "description": "the ID of the load balancer rule", @@ -93827,29 +100921,36 @@ "type": "uuid" }, { - "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", + "description": "name of the load balancer stickiness policy method, possible values can be obtained from listNetworks API", "length": 255, - "name": "param", - "required": false, - "type": "map" + "name": "methodname", + "required": true, + "type": "string" + }, + { + "description": "name of the load balancer stickiness policy", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "listLBStickinessPolicies", "response": [ + {}, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" }, - {}, { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, { @@ -93857,29 +100958,44 @@ "name": "zoneid", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account of the Stickiness policy", + "name": "account", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the description of the Stickiness policy", "name": "description", "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the state of the policy", + "name": "state", "type": "string" }, + {}, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { @@ -93888,20 +101004,25 @@ "type": "map" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the method name of the Stickiness policy", + "name": "methodname", "type": "string" }, { - "description": "the LB Stickiness policy ID", - "name": "id", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the state of the policy", "name": "state", @@ -93909,26 +101030,6 @@ } ], "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the account of the Stickiness policy", - "name": "account", - "type": "string" - }, - { - "description": "the 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" } ], "since": "3.0.0" @@ -93939,12 +101040,11 @@ "name": "addCiscoAsa1000vResource", "params": [ { - "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", @@ -93962,15 +101062,17 @@ "type": "uuid" }, { - "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "description": "the Cluster ID", "length": 255, - "name": "hostname", + "name": "clusterid", + "related": "addCluster", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ + {}, {}, {}, { @@ -93978,15 +101080,14 @@ "name": "jobstatus", "type": "integer" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, - {}, - {}, - {}, {} ] }, @@ -94014,13 +101115,19 @@ "related": "addPaloAltoFirewall,listPaloAltoFirewalls", "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": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the username that's used to log in to the external firewall", + "name": "username", + "type": "string" + }, + {}, + { + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { @@ -94029,70 +101136,64 @@ "type": "long" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", - "type": "string" - }, - { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "device state", + "name": "fwdevicestate", "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": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, - {}, { "description": "the physical network to which this Palo Alto firewall belongs to", "name": "physicalnetworkid", "type": "string" }, + {}, { "description": "device id of the Palo Alto firewall", "name": "fwdeviceid", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the private interface of the external firewall", + "name": "privateinterface", "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" }, { @@ -94101,8 +101202,8 @@ "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" } ] @@ -94113,123 +101214,112 @@ "name": "updateNetworkACLItem", "params": [ { - "description": "Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "partialupgrade", + "name": "customid", "required": false, - "type": "boolean" + "since": "4.4", + "type": "string" }, { - "description": "The network of the vm the ACL will be created for", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "number", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "traffictype", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the ID of the network ACL item", + "description": "error code for this ICMP message", "length": 255, - "name": "id", - "related": "updateNetworkACLItem,moveNetworkAclItem", - "required": true, - "type": "uuid" + "name": "icmpcode", + "required": false, + "type": "integer" }, { - "description": "the starting port of ACL", + "description": "the ending port of ACL", "length": 255, - "name": "startport", + "name": "endport", "required": false, "type": "integer" }, { - "description": "A description indicating why the ACL rule is required.", + "description": "scl entry action, allow or deny", "length": 255, - "name": "reason", + "name": "action", "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": "Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.", "length": 255, - "name": "customid", + "name": "partialupgrade", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "cidrlist", + "name": "traffictype", "required": false, - "type": "list" + "type": "string" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "The network of the vm the ACL will be created for", "length": 255, - "name": "protocol", + "name": "number", "required": false, - "type": "string" + "type": "integer" }, { - "description": "scl entry action, allow or deny", + "description": "type of the ICMP message being sent", "length": 255, - "name": "action", + "name": "icmptype", "required": false, - "type": "string" + "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": "A description indicating why the ACL rule is required.", "length": 255, - "name": "icmpcode", + "name": "reason", "required": false, - "type": "integer" + "type": "string" }, { - "description": "type of the ICMP message being sent", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "icmptype", + "name": "protocol", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ending port of ACL", + "description": "the starting port of ACL", "length": 255, - "name": "endport", + "name": "startport", "required": false, "type": "integer" } ], "related": "moveNetworkAclItem", "response": [ - {}, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, - { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, { @@ -94238,24 +101328,14 @@ "type": "string" }, { - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the state of the rule", @@ -94263,34 +101343,23 @@ "type": "string" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { @@ -94298,13 +101367,13 @@ "name": "tags", "response": [ { - "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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -94313,51 +101382,83 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "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": "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": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, + {}, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "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 ACL this item belongs to", + "name": "aclid", + "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": "the starting port of ACL's port range", + "name": "startport", + "type": "string" + }, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" } ] @@ -94392,6 +101493,12 @@ } ], "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", @@ -94403,16 +101510,10 @@ "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.11" @@ -94431,41 +101532,33 @@ "type": "boolean" }, { - "description": "list by network 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": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the disk router", + "description": "List networks by VPC", "length": 255, - "name": "id", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "the state of the router", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the state 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": "state", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the Pod ID of the router", @@ -94476,13 +101569,20 @@ "type": "uuid" }, { - "description": "the cluster ID of the router", + "description": "the Zone ID of the router", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "zoneid", + "related": "createZone,listZones", "required": false, "type": "uuid" }, + { + "description": "list virtual router elements by version", + "length": 255, + "name": "version", + "required": false, + "type": "string" + }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -94499,56 +101599,64 @@ "type": "string" }, { - "description": "the host ID of the router", + "description": "if this parameter is passed, list only routers by health check results", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", + "name": "healthchecksfailed", "required": false, - "type": "uuid" + "since": "4.16", + "type": "boolean" }, { - "description": "List networks by VPC", + "description": "the name of the router", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the cluster ID of the router", + "length": 255, + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, { - "description": "list virtual router elements by version", + "description": "list by network id", "length": 255, - "name": "version", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "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": "the ID of the disk router", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "if true is passed for this parameter, list only VPC routers", + "description": "", "length": 255, - "name": "forvpc", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the Zone ID of the router", + "description": "if true is passed for this parameter, list only VPC routers", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "forvpc", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list only resources belonging to the domain specified", @@ -94559,24 +101667,17 @@ "type": "uuid" }, { - "description": "if this parameter is passed, list only routers by health check results", - "length": 255, - "name": "healthchecksfailed", - "required": false, - "since": "4.16", - "type": "boolean" - }, - { - "description": "the name of the router", + "description": "the host ID of the router", "length": 255, - "name": "name", + "name": "hostid", + "related": "reconnectHost,addBaremetalHost", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -94584,28 +101685,28 @@ "related": "destroyRouter", "response": [ { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the id of the router", + "name": "id", + "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { @@ -94613,14 +101714,90 @@ "name": "version", "type": "string" }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + {}, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "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 project name of the address", "name": "project", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { @@ -94628,88 +101805,68 @@ "name": "nic", "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -94718,8 +101875,8 @@ "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -94728,9 +101885,9 @@ "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { "description": "the ID of the corresponding network", @@ -94743,18 +101900,13 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -94763,133 +101915,56 @@ "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" - } - ], - "type": "set" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "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 Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - {}, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - {}, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + } + ], + "type": "set" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { @@ -94898,13 +101973,13 @@ "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -94913,58 +101988,58 @@ "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the name of the router", + "name": "name", "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 public MAC address for the router", - "name": "publicmacaddress", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "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 link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -94972,9 +102047,14 @@ "name": "healthcheckresults", "response": [ { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" }, { "description": "detailed response generated on running health check", @@ -94982,31 +102062,52 @@ "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": "the name of the health check on the router", - "name": "checkname", - "type": "string" } ], "type": "list" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, + {}, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { @@ -95015,14 +102116,24 @@ "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "role of the domain router", - "name": "role", + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" } ] }, @@ -95035,26 +102146,99 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addBaremetalHost,reconnectHost", + "related": "reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + } + ] + }, + { + "description": "list Tungsten-Fabric vm", + "isasync": false, + "name": "listTungstenFabricVm", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric vm", + "length": 255, + "name": "vmuuid", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric vm name", + "name": "name", + "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" }, { @@ -95062,6 +102246,11 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "Tungsten-Fabric nic uuid", + "name": "uuid", + "type": "string" + }, {} ] }, @@ -95078,13 +102267,6 @@ "required": true, "type": "uuid" }, - { - "description": "connection is passive or not", - "length": 255, - "name": "passive", - "required": false, - "type": "boolean" - }, { "description": "id of the vpn gateway", "length": 255, @@ -95100,13 +102282,67 @@ "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "connection is passive or not", + "length": 255, + "name": "passive", + "required": false, + "type": "boolean" } ], "related": "", "response": [ { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "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": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "the connection ID", + "name": "id", + "type": "string" + }, + { + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "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": "State of vpn connection", + "name": "state", "type": "string" }, { @@ -95115,8 +102351,48 @@ "type": "boolean" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "the project id", + "name": "projectid", + "type": "string" + }, + { + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" + }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the 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": "the public IP address", + "name": "publicip", + "type": "string" + }, + { + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { @@ -95124,180 +102400,371 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" + }, + { + "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": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" + }, { "description": "is connection for display to the regular user", "name": "fordisplay", "type": "boolean" + } + ] + }, + { + "description": "lists network that are using a brocade vcs switch", + "isasync": false, + "name": "listBrocadeVcsDeviceNetworks", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "brocade vcs switch ID", + "length": 255, + "name": "vcsdeviceid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "response": [ + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" + }, + { + "description": "the owner of the network", + "name": "account", + "type": "string" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the project name", - "name": "project", + "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 date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "the owner", - "name": "account", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, - {}, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the project id", + "description": "the project id of the ipaddress", "name": "projectid", "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, - {}, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", - "type": "string" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the type of the network", + "name": "type", "type": "string" - } - ] - }, - { - "description": "lists network that are using a brocade vcs switch", - "isasync": false, - "name": "listBrocadeVcsDeviceNetworks", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "brocade vcs switch ID", - "length": 255, - "name": "vcsdeviceid", - "related": "", - "required": true, - "type": "uuid" - } - ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "response": [ - { - "description": "The external id of the network", - "name": "externalid", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { @@ -95306,23 +102773,18 @@ "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "state of the network", + "name": "state", "type": "string" }, { @@ -95331,19 +102793,19 @@ "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { "description": "true network requires restart", @@ -95351,24 +102813,35 @@ "type": "boolean" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, + {}, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" }, { "description": "the displaytext of the network", @@ -95376,416 +102849,375 @@ "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the first DNS for the network", - "name": "dns1", + "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", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the type of the network", - "name": "type", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, + {}, { - "description": "related to what other network configuration", - "name": "related", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the project name of the address", - "name": "project", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "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 service provider name", - "name": "provider", - "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { "description": "availability of the network offering the network is created from", "name": "networkofferingavailability", "type": "string" - }, + } + ] + }, + { + "description": "Deletes a Physical Network.", + "isasync": true, + "name": "deletePhysicalNetwork", + "params": [ { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" - }, + "description": "the ID of the Physical network", + "length": 255, + "name": "id", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the network domain", - "name": "networkdomain", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "add Tungsten-Fabric policy rule", + "isasync": true, + "name": "addTungstenFabricPolicyRule", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "Tungsten-Fabric policy rule source start port", + "length": 255, + "name": "srcstartport", + "required": true, + "type": "integer" + }, + { + "description": "Tungsten-Fabric policy rule protocol", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "Tungsten-Fabric policy rule source end port", + "length": 255, + "name": "srcendport", + "required": true, + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Tungsten-Fabric policy rule destination start port", + "length": 255, + "name": "deststartport", + "required": true, "type": "integer" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" + "description": "Tungsten-Fabric policy rule destination end port", + "length": 255, + "name": "destendport", + "required": true, + "type": "integer" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric policy rule source ip prefix", + "length": 255, + "name": "srcipprefix", + "required": true, "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "Tungsten-Fabric policy rule destination ip prefix", + "length": 255, + "name": "destipprefix", + "required": true, "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "Tungsten-Fabric policy rule destination ip prefix length", + "length": 255, + "name": "destipprefixlen", + "required": true, + "type": "integer" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "Tungsten-Fabric policy rule destination network", + "length": 255, + "name": "destnetwork", + "required": true, "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "Tungsten-Fabric policy rule source ip prefix length", + "length": 255, + "name": "srcipprefixlen", + "required": true, + "type": "integer" + }, + { + "description": "Tungsten-Fabric policy rule direction", + "length": 255, + "name": "direction", + "required": true, "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "Tungsten-Fabric policy rule action", + "length": 255, + "name": "action", + "required": true, "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": "Tungsten-Fabric policy rule source network", + "length": 255, + "name": "srcnetwork", + "required": true, "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "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": "the physical network id", - "name": "physicalnetworkid", + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", + "type": "int" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", + "type": "int" }, + {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "Tungsten-Fabric provider zone name", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", + "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - } - ] - }, - { - "description": "Deletes a Physical Network.", - "isasync": true, - "name": "deletePhysicalNetwork", - "params": [ - { - "description": "the ID of the Physical network", - "length": 255, - "name": "id", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - } - ], - "response": [ + "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 name", + "name": "direction", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" } - ], - "since": "3.0.0" + ] }, { "description": "Dedicates a host.", @@ -95793,10 +103225,10 @@ "name": "dedicateHost", "params": [ { - "description": "the ID of the containing domain", + "description": "the ID of the host to update", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "hostid", + "related": "reconnectHost,addBaremetalHost", "required": true, "type": "uuid" }, @@ -95808,38 +103240,21 @@ "type": "string" }, { - "description": "the ID of the host to update", + "description": "the ID of the containing domain", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": true, "type": "uuid" } ], "related": "listDedicatedHosts", "response": [ - {}, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the domain ID of the host", - "name": "domainid", - "type": "string" - }, - { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", - "type": "string" - }, { "description": "the name of the host", "name": "hostname", @@ -95850,16 +103265,33 @@ "name": "jobid", "type": "string" }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, { "description": "the ID of the dedicated resource", "name": "id", "type": "string" }, + {}, { "description": "the Account ID of the host", "name": "accountid", "type": "string" - } + }, + { + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", + "type": "string" + }, + { + "description": "the domain ID of the host", + "name": "domainid", + "type": "string" + }, + {} ] }, { @@ -95868,13 +103300,20 @@ "name": "removeVpnUser", "params": [ { - "description": "remove vpn user from the project", + "description": "an optional domainId for the vpn user. 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" }, + { + "description": "an optional account for the vpn user. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "username for the vpn user", "length": 255, @@ -95883,19 +103322,12 @@ "type": "string" }, { - "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "description": "remove vpn user from the project", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, "type": "uuid" - }, - { - "description": "an optional account for the vpn user. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "response": [ @@ -95904,23 +103336,23 @@ "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {} + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -95928,13 +103360,6 @@ "isasync": true, "name": "addGloboDnsHost", "params": [ - { - "description": "Password for GloboDNS", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, { "description": "GloboDNS url", "length": 255, @@ -95956,16 +103381,23 @@ "name": "username", "required": true, "type": "string" + }, + { + "description": "Password for GloboDNS", + "length": 255, + "name": "password", + "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", @@ -95977,9 +103409,9 @@ "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.5.0" @@ -95991,9 +103423,10 @@ "params": [], "related": "", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Response description", + "name": "description", "type": "string" }, { @@ -96001,13 +103434,12 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "Response description", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {}, - {} + } ] }, { @@ -96025,12 +103457,18 @@ } ], "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", @@ -96040,12 +103478,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" } ], "since": "4.2.0" @@ -96056,11 +103488,11 @@ "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.", + "description": "Creates a role with this unique name", "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", @@ -96070,49 +103502,47 @@ "type": "string" }, { - "description": "The description of the role", + "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": "description", - "required": false, - "type": "string" + "name": "rules", + "required": true, + "type": "map" }, { - "description": "Creates a role with this unique name", + "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": "name", - "required": true, - "type": "string" + "name": "forced", + "required": false, + "type": "boolean" }, { - "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", + "description": "The description of the role", "length": 255, - "name": "rules", - "required": true, - "type": "map" + "name": "description", + "required": false, + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the description of the role", - "name": "description", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of the role", + "name": "type", "type": "string" }, - {}, { "description": "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", - "name": "type", + "description": "the description of the role", + "name": "description", "type": "string" }, { @@ -96129,7 +103559,9 @@ "description": "the name of the role", "name": "name", "type": "string" - } + }, + {}, + {} ], "since": "4.15.0" }, @@ -96145,13 +103577,6 @@ "required": false, "type": "integer" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "the id of the swift", "length": 255, @@ -96165,81 +103590,88 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "addImageStoreS3,listImageStores", "response": [ { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + {}, { "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the name of the image store", + "name": "name", "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 ID of the image store", + "name": "id", "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 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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the url of the image store", - "name": "url", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "3.0.0" @@ -96253,37 +103685,28 @@ "description": "ID of the host", "length": 255, "name": "hostid", - "related": "addBaremetalHost,reconnectHost", + "related": "reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, + {}, { "description": "the ID of the host", "name": "hostid", "type": "string" }, - {}, - { - "description": "operation status", - "name": "status", - "type": "boolean" - }, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, - { - "description": "if host HA is enabled for the host", - "name": "haenable", + { + "description": "operation status", + "name": "status", "type": "boolean" }, { @@ -96292,11 +103715,20 @@ "type": "integer" }, { - "description": "the host HA provider", - "name": "haprovider", + "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": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + } ], "since": "4.11" }, @@ -96309,7 +103741,7 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "addBaremetalHost,reconnectHost", + "related": "reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } @@ -96317,9 +103749,14 @@ "related": "disableOutOfBandManagementForCluster", "response": [ { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" + }, + { + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" }, { "description": "the operation result", @@ -96328,18 +103765,19 @@ }, {}, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, + {}, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -96348,40 +103786,34 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "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", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, { "description": "the 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 operation result description", - "name": "description", - "type": "string" } ], "since": "4.9.0" @@ -96401,17 +103833,7 @@ } ], "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", @@ -96422,6 +103844,16 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -96430,27 +103862,6 @@ "isasync": false, "name": "listKubernetesSupportedVersions", "params": [ - { - "description": "the minimum semantic version for the Kubernetes supported version to be listed", - "length": 255, - "name": "minimumsemanticversion", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -96466,6 +103877,13 @@ "required": false, "type": "uuid" }, + { + "description": "the minimum semantic version for the Kubernetes supported version to be listed", + "length": 255, + "name": "minimumsemanticversion", + "required": false, + "type": "string" + }, { "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, @@ -96481,44 +103899,63 @@ "related": "listKubernetesSupportedVersions", "required": false, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "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", - "type": "string" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", - "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": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "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 id of the binaries ISO for Kubernetes supported version", @@ -96526,14 +103963,14 @@ "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "Name of the Kubernetes supported version", @@ -96541,31 +103978,26 @@ "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": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "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 enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" - }, - { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" } ] }, @@ -96574,6 +104006,20 @@ "isasync": true, "name": "addNiciraNvpDevice", "params": [ + { + "description": "Credentials to access the Nicira Controller API", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "Hostname of ip address of the Nicira NVP Controller.", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" + }, { "description": "The L3 Gateway Service UUID configured on the Nicira Controller", "length": 255, @@ -96582,16 +104028,16 @@ "type": "string" }, { - "description": "Credentials to access the Nicira Controller API", + "description": "The L2 Gateway Service UUID configured on the Nicira Controller", "length": 255, - "name": "username", - "required": true, + "name": "l2gatewayserviceuuid", + "required": false, "type": "string" }, { "description": "Credentials to access the Nicira Controller API", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, @@ -96602,13 +104048,6 @@ "required": true, "type": "string" }, - { - "description": "The L2 Gateway Service UUID configured on the Nicira Controller", - "length": 255, - "name": "l2gatewayserviceuuid", - "required": false, - "type": "string" - }, { "description": "the Physical Network ID", "length": 255, @@ -96616,31 +104055,18 @@ "related": "createPhysicalNetwork", "required": true, "type": "uuid" - }, - { - "description": "Hostname of ip address of the Nicira NVP Controller.", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" } ], "related": "", "response": [ - {}, { "description": "device id of the Nicire Nvp", "name": "nvpdeviceid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", + "description": "device name", + "name": "niciradevicename", "type": "string" }, {}, @@ -96650,13 +104076,19 @@ "type": "string" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { - "description": "device name", - "name": "niciradevicename", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" }, { @@ -96664,19 +104096,19 @@ "name": "l2gatewayserviceuuid", "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 controller Ip address", - "name": "hostname", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", "type": "string" } ] @@ -96687,31 +104119,24 @@ "name": "listNetworkServiceProviders", "params": [ { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "list providers by state", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, { - "description": "list providers by state", + "description": "the Physical Network ID", "length": 255, - "name": "state", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -96722,34 +104147,53 @@ "required": false, "type": "string" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "", "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 destination physical network", "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -96758,16 +104202,51 @@ "type": "string" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "delete Tungsten-Fabric tag type", + "isasync": true, + "name": "deleteTungstenFabricTagType", + "params": [ + { + "description": "the ID of Tungsten-Fabric tag type", + "length": 255, + "name": "tagtypeuuid", + "required": true, + "type": "string" }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -96775,12 +104254,11 @@ }, {}, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } - ], - "since": "3.0.0" + ] }, { "description": "Lists infrastructure", @@ -96790,28 +104268,34 @@ "related": "", "response": [ { - "description": "Number of zones", - "name": "zones", + "description": "Number of hypervisor hosts", + "name": "hosts", "type": "integer" }, { - "description": "Number of storage pools", - "name": "storagepools", + "description": "Number of routers", + "name": "routers", "type": "integer" }, { - "description": "Number of cpu sockets", - "name": "cpusockets", + "description": "Number of images stores", + "name": "imagestores", "type": "integer" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Number of clusters", "name": "clusters", "type": "integer" }, { - "description": "Number of Alerts", - "name": "alerts", + "description": "Number of systemvms", + "name": "systemvms", "type": "integer" }, { @@ -96819,46 +104303,40 @@ "name": "managementservers", "type": "integer" }, + {}, { - "description": "Number of hypervisor hosts", - "name": "hosts", + "description": "Number of zones", + "name": "zones", "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Number of storage pools", + "name": "storagepools", "type": "integer" }, - {}, { - "description": "Number of systemvms", - "name": "systemvms", + "description": "Number of pods", + "name": "pods", "type": "integer" }, { - "description": "Number of images stores", - "name": "imagestores", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Number of pods", - "name": "pods", + "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 cpu sockets", + "name": "cpusockets", "type": "integer" }, { - "description": "Number of internal LBs", - "name": "ilbvms", + "description": "Number of Alerts", + "name": "alerts", "type": "integer" } ], @@ -96870,60 +104348,61 @@ "name": "listUsageRecords", "params": [ { - "description": "List usage records for the specified usage type", + "description": "Flag to enable display of Tags for a resource", "length": 255, - "name": "type", + "name": "includetags", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "List by keyword", + "description": "List usage records for the specified domain.", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", + "description": "List usage records for specified project", "length": 255, - "name": "oldformat", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "End date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00).", + "description": "Start date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00).", "length": 255, - "name": "enddate", + "name": "startdate", "required": true, "type": "date" }, { - "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", + "description": "List usage records for the specified user.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "since": "4.15", - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "List usage records for the specified usage type", "length": 255, - "name": "pagesize", + "name": "type", "required": false, - "type": "integer" + "type": "long" }, { - "description": "Flag to enable display of Tags for a resource", + "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": "includetags", - "required": false, - "type": "boolean" + "name": "enddate", + "required": true, + "type": "date" }, { - "description": "List usage records for specified project", + "description": "List usage records for the specified account", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "accountid", + "related": "enableAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, @@ -96935,12 +104414,18 @@ "type": "string" }, { - "description": "List usage records for the specified domain.", + "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", + "length": 255, + "name": "oldformat", + "required": false, + "type": "boolean" + }, + { + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -96950,89 +104435,78 @@ "type": "integer" }, { - "description": "List usage records for the specified user.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Start date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00).", - "length": 255, - "name": "startdate", - "required": true, - "type": "date" - }, - { - "description": "List usage records for the specified account", + "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" } ], "related": "", "response": [ { - "description": "virtual machine os type ID", - "name": "ostypeid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "usageid", + "description": "resource or virtual machine name", + "name": "name", "type": "string" }, { - "description": "the domain the resource is associated with", - "name": "domain", - "type": "string" + "description": "resource size", + "name": "size", + "type": "long" }, { - "description": "memory allocated for the resource", - "name": "memory", + "description": "virtual size of resource", + "name": "virtualsize", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "description of the usage record", + "name": "description", + "type": "string" }, { - "description": "resource or virtual machine name", - "name": "name", + "description": "raw usage in hours", + "name": "rawusage", "type": "string" }, { - "description": "number of cpu of resource", - "name": "cpunumber", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the user account name", - "name": "account", + "description": "the project id of the resource", + "name": "projectid", "type": "string" }, { - "description": "id of the vpc", - "name": "vpcid", + "description": "the domain the resource is associated with", + "name": "domain", "type": "string" }, { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", - "type": "boolean" + "description": "virtual machine os category name", + "name": "oscategoryname", + "type": "string" }, { - "description": "speed of each cpu of resource", - "name": "cpuspeed", + "description": "number of cpu of resource", + "name": "cpunumber", "type": "long" }, { - "description": "resource size", - "name": "size", - "type": "long" + "description": "start date of the usage record", + "name": "startdate", + "type": "string" }, { "description": "the user account Id", @@ -97040,24 +104514,29 @@ "type": "string" }, { - "description": "id of the network", - "name": "networkid", + "description": "memory allocated for the resource", + "name": "memory", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "virtual machine os category name", - "name": "oscategoryname", + "description": "the user account name", + "name": "account", "type": "string" }, { - "description": "offering ID", - "name": "offeringid", + "description": "virtual machine os display name", + "name": "osdisplayname", "type": "string" }, { - "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", - "name": "issystem", - "type": "boolean" + "description": "virtual machine ID", + "name": "virtualmachineid", + "type": "string" }, { "description": "the project name of the resource", @@ -97065,106 +104544,125 @@ "type": "string" }, { - "description": "usage type ID", - "name": "usagetype", - "type": "integer" + "description": "True if the resource is default", + "name": "isdefault", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "resource type", + "name": "type", "type": "string" }, - {}, + { + "description": "virtual machine os type ID", + "name": "ostypeid", + "type": "string" + }, + { + "description": "speed of each cpu of resource", + "name": "cpuspeed", + "type": "long" + }, { "description": "end date of the usage record", "name": "enddate", "type": "string" }, { - "description": "the domain ID", - "name": "domainid", + "description": "template ID", + "name": "templateid", "type": "string" }, { - "description": "raw usage in hours", - "name": "rawusage", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "id of the network", + "name": "networkid", "type": "string" }, { - "description": "True if the resource is default", - "name": "isdefault", - "type": "boolean" + "description": "usage in hours", + "name": "usage", + "type": "string" }, { - "description": "virtual machine ID", - "name": "virtualmachineid", + "description": "id of the resource", + "name": "usageid", "type": "string" }, + { + "description": "usage type ID", + "name": "usagetype", + "type": "integer" + }, { "description": "the list of resource tags associated", "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": "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": "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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": "set" }, { - "description": "resource type", - "name": "type", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", + "name": "issystem", "type": "boolean" }, { @@ -97172,45 +104670,25 @@ "name": "oscategoryid", "type": "string" }, - { - "description": "virtual size of resource", - "name": "virtualsize", - "type": "long" - }, - { - "description": "virtual machine os display name", - "name": "osdisplayname", - "type": "string" - }, - {}, - { - "description": "the project id of the resource", - "name": "projectid", - "type": "string" - }, { "description": "the zone ID", "name": "zoneid", "type": "string" }, { - "description": "description of the usage record", - "name": "description", - "type": "string" - }, - { - "description": "usage in hours", - "name": "usage", + "description": "the domain ID", + "name": "domainid", "type": "string" }, { - "description": "template ID", - "name": "templateid", + "description": "id of the vpc", + "name": "vpcid", "type": "string" }, + {}, { - "description": "start date of the usage record", - "name": "startdate", + "description": "offering ID", + "name": "offeringid", "type": "string" } ] @@ -97235,13 +104713,13 @@ "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", @@ -97270,14 +104748,15 @@ ], "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": "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" }, { @@ -97289,8 +104768,7 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { @@ -97310,123 +104788,201 @@ "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, + {}, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "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": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, { "description": "type of the disk volume (ROOT or DATADISK)", "name": "type", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "pod name of the volume", + "name": "podname", "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 state of the disk volume", - "name": "state", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, { "description": "shared or local storage", "name": "storagetype", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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": "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" + } + ], + "type": "set" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "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": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { @@ -97435,121 +104991,150 @@ "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the state of the disk volume", + "name": "state", "type": "string" }, + { + "description": "the 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": "ID of the snapshot from which this volume was created", "name": "snapshotid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "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": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, {}, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "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": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { "description": "the project id of the vpn", @@ -97557,9 +105142,9 @@ "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { "description": "the account associated with the disk volume", @@ -97567,139 +105152,106 @@ "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, { "description": "the display text of the disk offering", "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "ID of the disk volume", + "name": "id", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "remove Tungsten-Fabric network gateway from logical router", + "isasync": true, + "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", + "params": [ + { + "description": "Tungsten-Fabric logical router uuid", + "length": 255, + "name": "logicalrouteruuid", + "required": true, "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "Tungsten-Fabric network uuid", + "length": 255, + "name": "networkuuid", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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": "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": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "Tungsten-Fabric logical router name", + "name": "name", "type": "string" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" } - ], - "since": "4.14.0" + ] }, { "description": "Enables a user account", @@ -97717,40 +105269,50 @@ ], "related": "createUser,getUser", "response": [ - {}, { - "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": "the user state", - "name": "state", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the account name of the user", + "name": "account", "type": "string" }, + { + "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", - "name": "domainid", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user email address", + "name": "email", "type": "string" }, { @@ -97764,33 +105326,28 @@ "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -97799,13 +105356,8 @@ "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -97813,32 +105365,42 @@ "name": "isdefault", "type": "boolean" }, + {}, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the 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 state", + "name": "state", + "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, - {} + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + } ] }, { @@ -97847,54 +105409,61 @@ "name": "listZonesMetrics", "params": [ { - "description": "the ID of the zone", + "description": "", "length": 255, - "name": "id", - "related": "createZone,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "flag to display the resource image for the zones", + "description": "List by keyword", "length": 255, - "name": "showicon", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "flag to display the capacity of the zones", + "description": "the name of the zone", "length": 255, - "name": "showcapacities", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "the network type of the zone that the virtual machine belongs to", "length": 255, - "name": "pagesize", + "name": "networktype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the name of the zone", + "description": "flag to display the capacity of the zones", "length": 255, - "name": "name", + "name": "showcapacities", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List by keyword", + "description": "the ID of the zone", "length": 255, - "name": "keyword", + "name": "id", + "related": "createZone,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "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.", + "length": 255, + "name": "available", + "required": false, + "type": "boolean" }, { "description": "the ID of the domain associated with the zone", @@ -97905,19 +105474,12 @@ "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": "flag to display the resource image for the zones", "length": 255, - "name": "available", + "name": "showicon", "required": false, "type": "boolean" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List zones by resource tags (key/value pairs)", "length": 255, @@ -97930,102 +105492,108 @@ "related": "", "response": [ { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", + "type": "string" }, { - "description": "Zone id", - "name": "id", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, + {}, { "description": "memory usage notification threshold exceeded", "name": "memorythreshold", "type": "boolean" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", + "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "Zone name", - "name": "name", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, { "description": "the Cluster name", "name": "clustername", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the capacity name", + "name": "name", + "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "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" }, { @@ -98033,48 +105601,62 @@ "name": "capacityused", "type": "long" }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, { "description": "the Zone ID", "name": "zoneid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the Pod ID", - "name": "podid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the capacity name", - "name": "name", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" } ], "type": "list" }, - {}, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Zone id", + "name": "id", + "type": "string" + }, + { + "description": "the total cpu used in GiB", + "name": "memoryused", + "type": "string" + }, + { + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", "type": "boolean" }, { @@ -98083,47 +105665,98 @@ "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + { + "description": "Zone name", + "name": "name", "type": "string" }, + {}, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, + { + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" + }, + { + "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", + "description": "the total cpu used in Ghz", + "name": "cpuused", + "type": "string" + }, + { + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", "type": "integer" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" + }, + { + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, + { + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" + }, { "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -98136,138 +105769,87 @@ "name": "project", "type": "string" }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the 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": "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": "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" } ], "type": "set" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" - }, - { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, - {}, - { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "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", - "type": "string" - }, - { - "description": "healthy / total clusters in the zone", - "name": "clusters", - "type": "string" - }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "type": "boolean" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" - }, - { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", - "type": "string" - }, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", "type": "boolean" } ], @@ -98278,13 +105860,6 @@ "isasync": true, "name": "extractTemplate", "params": [ - { - "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, @@ -98300,6 +105875,13 @@ "required": true, "type": "uuid" }, + { + "description": "the url to which the ISO would be extracted", + "length": 2048, + "name": "url", + "required": false, + "type": "string" + }, { "description": "the ID of the zone where the ISO is originally located", "length": 255, @@ -98312,19 +105894,23 @@ "related": "", "response": [ { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" }, - {}, { - "description": "the id of extracted object", - "name": "id", + "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", + "description": "the time and date the object was created", + "name": "created", + "type": "date" + }, + { + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", "type": "integer" }, { @@ -98333,49 +105919,45 @@ "type": "string" }, { - "description": "the status of the extraction", - "name": "status", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the extracted object", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { @@ -98384,13 +105966,13 @@ "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "", + "name": "resultstring", "type": "string" } ] @@ -98411,27 +105993,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": "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ] }, { @@ -98451,119 +106033,52 @@ "related": "activateProject", "response": [ { - "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 running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the state of the project", - "name": "state", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the 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 displaytext of the project", - "name": "displaytext", + "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 account name of the project's owners", + "name": "owner", + "type": "list" }, { "description": "the total primary storage space (in GiB) owned by project", "name": "primarystoragetotal", "type": "long" }, - { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the name of the project", - "name": "name", - "type": "string" - }, - { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - {}, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "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": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -98572,8 +106087,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -98582,71 +106097,81 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the 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" } ], "type": "list" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { @@ -98655,18 +106180,19 @@ "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" }, + {}, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { @@ -98675,18 +106201,23 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { @@ -98694,6 +106225,16 @@ "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 vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, { "description": "the total memory (in MB) the project can own", "name": "memorylimit", @@ -98704,44 +106245,85 @@ "name": "jobid", "type": "string" }, + { + "description": "the name of the project", + "name": "name", + "type": "string" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "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 date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, { "description": "the id of the project", "name": "id", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" + }, + {}, + { + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "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" } ], @@ -98761,74 +106343,69 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the IP to the end user or not", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "fordisplay", + "name": "customid", "required": false, "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" } ], "related": "associateIpAddress,listPublicIpAddresses", "response": [ + {}, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", - "type": "string" + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { - "description": "is public IP portable across the zones", - "name": "isportable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" }, - {}, { - "description": "public IP address", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, {}, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { @@ -98836,18 +106413,13 @@ "name": "tags", "response": [ { - "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": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -98856,23 +106428,23 @@ "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -98881,26 +106453,31 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", + "description": "is public IP portable across the zones", + "name": "isportable", "type": "boolean" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachineid", "type": "string" }, { @@ -98909,13 +106486,8 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { @@ -98924,68 +106496,63 @@ "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": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "is public ip 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 VLAN associated with the IP address", - "name": "vlanname", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "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": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachineid", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the name of the zone the public IP address 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 VLAN associated with the IP address", + "name": "vlanname", + "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "public IP address id", - "name": "id", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { @@ -98994,8 +106561,8 @@ "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -99004,8 +106571,23 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "public IP address id", + "name": "id", + "type": "string" + }, + { + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" } ] @@ -99018,179 +106600,362 @@ "related": "", "response": [ { - "description": "the account name of the api remaining count", + "description": "the account uuid of the api remaining count", + "name": "accountid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "currently allowed number of apis", + "name": "apiAllowed", + "type": "int" + }, + { + "description": "seconds left to reset counters", + "name": "expireAfter", + "type": "long" + }, + { + "description": "the account name of the api remaining count", + "name": "account", + "type": "string" + }, + { + "description": "number of api already issued", + "name": "apiIssued", + "type": "int" + }, + {} + ] + }, + { + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ], + "since": "3.0.0" + }, + { + "description": "moves a network to another physical network", + "isasync": true, + "name": "migrateNetwork", + "params": [ + { + "description": "true if previous network migration cmd failed", + "length": 255, + "name": "resume", + "required": false, + "type": "boolean" + }, + { + "description": "network offering ID", + "length": 255, + "name": "networkofferingid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": true, + "type": "uuid" + } + ], + "related": "createNetwork,updateNetwork,listNetworks", + "response": [ + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "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": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "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", + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", "type": "integer" }, { - "description": "currently allowed number of apis", - "name": "apiAllowed", - "type": "int" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "the account uuid of the api remaining count", - "name": "accountid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, - {}, - {}, { - "description": "seconds left to reset counters", - "name": "expireAfter", - "type": "long" + "description": "The external id of the network", + "name": "externalid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "number of api already issued", - "name": "apiIssued", - "type": "int" - } - ] - }, - { - "description": "Deletes a storage network IP Range.", - "isasync": true, - "name": "deleteStorageNetworkIpRange", - "params": [ + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, { - "description": "the uuid of the storage network ip range", - "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "moves a network to another physical network", - "isasync": true, - "name": "migrateNetwork", - "params": [ { - "description": "the ID of the network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": true, - "type": "uuid" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "", - "required": true, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if previous network migration cmd failed", - "length": 255, - "name": "resume", - "required": false, - "type": "boolean" - } - ], - "related": "createNetwork,updateNetwork,listNetworks", - "response": [ + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, {}, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" - }, { "description": "network offering id the network is created from", "name": "networkofferingid", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { @@ -99199,39 +106964,33 @@ "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, - {}, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { @@ -99240,140 +106999,73 @@ "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": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the name of the network", - "name": "name", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "related to what other network configuration", - "name": "related", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "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": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the id of the network", - "name": "id", - "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", "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, { "description": "the capability value", "name": "value", @@ -99383,6 +107075,11 @@ "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" @@ -99391,6 +107088,16 @@ "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", @@ -99402,13 +107109,8 @@ "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -99417,180 +107119,90 @@ "type": "list" }, { - "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": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "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 name of the Network associated with this private gateway", + "description": "the name of the Network associated with this network", "name": "associatednetwork", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", - "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 domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "the domain name of the network owner", - "name": "domain", + "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", + "name": "id", "type": "string" }, - { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, { "description": "Broadcast domain type of the network", "name": "broadcastdomaintype", "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 owner of the network", - "name": "account", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the network's netmask", - "name": "netmask", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "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 project name of the address", - "name": "project", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "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", + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", "type": "integer" - }, - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "the first DNS for the network", - "name": "dns1", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the second 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": "the project id of the ipaddress", - "name": "projectid", - "type": "string" } ], "since": "4.11.0" @@ -99599,14 +107211,7 @@ "description": "Adds a VMware datacenter to specified zone", "isasync": false, "name": "addVmwareDc", - "params": [ - { - "description": "Name of VMware datacenter to be added to specified zone.", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, + "params": [ { "description": "The password for specified username.", "length": 255, @@ -99628,6 +107233,13 @@ "required": false, "type": "string" }, + { + "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, @@ -99640,37 +107252,37 @@ "related": "", "response": [ { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "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 Zone ID associated with this VMware Datacenter", "name": "zoneid", "type": "long" }, { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The VMware Datacenter name", - "name": "name", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" - }, - {} + } ] }, { @@ -99679,18 +107291,18 @@ "name": "updateIpv6FirewallRule", "params": [ { - "description": "the ending port of Ipv6 firewall rule", + "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "endport", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "type of the ICMP message being sent", "length": 255, - "name": "cidrlist", + "name": "icmptype", "required": false, - "type": "list" + "type": "integer" }, { "description": "error code for this ICMP message", @@ -99700,11 +107312,12 @@ "type": "integer" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "the ID of the ipv6 firewall rule", "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "name": "id", + "related": "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", @@ -99715,18 +107328,18 @@ "type": "string" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "traffictype", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the protocol for the Ipv6 firewall 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": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", @@ -99737,88 +107350,25 @@ "type": "boolean" }, { - "description": "type of the ICMP message being sent", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "icmptype", + "name": "endport", "required": false, "type": "integer" }, { - "description": "the ID of the ipv6 firewall rule", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "name": "protocol", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "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 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 ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "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" }, { @@ -99826,8 +107376,8 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -99836,23 +107386,28 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -99861,46 +107416,103 @@ "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", "type": "string" - }, - { - "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 VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "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 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 VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the 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 vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + {}, { "description": "the ending port of port forwarding rule's private port range", "name": "publicendport", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" } ] @@ -99911,38 +107523,38 @@ "name": "listUnmanagedInstances", "params": [ { - "description": "", + "description": "the hypervisor name of the instance", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "the cluster ID", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the cluster ID", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the hypervisor name of the instance", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" } @@ -99950,110 +107562,93 @@ "related": "", "response": [ { - "description": "the list of disks associated with the virtual machine", - "name": "disk", + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" + }, + { + "description": "the list of nics associated with the virtual machine", + "name": "nic", "response": [ { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the label of the disk", - "name": "label", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the position of the disk", - "name": "position", - "type": "integer" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorepath", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorename", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the disk", - "name": "id", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" - }, - { - "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", - "type": "string" - }, - { - "description": "the operating system ID of the virtual machine", - "name": "osid", - "type": "string" - }, - { - "description": "the list of nics associated with the virtual machine", - "name": "nic", - "response": [ + }, { - "description": "the ID of the nic", - "name": "id", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { "description": "the name of the corresponding network", @@ -100061,8 +107656,8 @@ "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -100071,48 +107666,48 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the traffic type of the nic", + "name": "traffictype", "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 vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -100121,109 +107716,131 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the power state of the virtual machine", + "name": "powerstate", + "type": "string" + }, + { + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", + "type": "string" + }, + { + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the controller of the disk", + "name": "datastorehost", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ID of the disk", + "name": "id", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the controller of the disk", + "name": "datastorename", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the label of the disk", + "name": "label", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the controller of the disk", + "name": "datastoretype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the file path of the disk image", + "name": "imagepath", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the controller of the disk", + "name": "controller", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" } ], "type": "set" }, { - "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", + "type": "string" }, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, + {}, { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", + "type": "string" }, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "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 name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.14.0" @@ -100234,58 +107851,63 @@ "name": "updateIsoPermissions", "params": [ { - "description": "true for featured template/iso, false otherwise", + "description": "the template ID", "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "name": "id", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "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.", + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "projectids", - "related": "activateProject", + "name": "accounts", "required": false, "type": "list" }, { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "permission operator (add, remove, reset)", "length": 255, - "name": "accounts", + "name": "op", "required": false, - "type": "list" + "type": "string" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "isextractable", + "name": "projectids", + "related": "activateProject", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "permission operator (add, remove, reset)", + "description": "true for featured template/iso, false otherwise", "length": 255, - "name": "op", + "name": "isfeatured", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the template ID", + "description": "true for public template/iso, false for private templates/isos", "length": 255, - "name": "id", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "name": "ispublic", + "required": false, + "type": "boolean" } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -100296,18 +107918,13 @@ "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" - }, - {}, - {} + } ] }, { @@ -100316,25 +107933,34 @@ "name": "registerTemplate", "params": [ { - "description": "the tag for this template.", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "templatetag", + "name": "sshkeyenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "directdownload", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if the template supports the password reset feature; default is false", + "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": "passwordenabled", + "name": "zoneids", + "related": "createZone,listZones", "required": false, - "type": "boolean" + "type": "list" + }, + { + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": true, + "type": "string" }, { "description": "true if the template type is routing i.e., if template is used to deploy router", @@ -100344,67 +107970,52 @@ "type": "boolean" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "ostypeid", - "related": "", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the name of the template", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, - "name": "name", + "name": "format", "required": true, "type": "string" }, { - "description": "the 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 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": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if this template requires HVM", "length": 255, - "name": "isdynamicallyscalable", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "the tag for this template.", "length": 255, - "name": "ispublic", + "name": "templatetag", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "the target hypervisor for the template", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "sshkeyenabled", + "name": "isextractable", "required": false, "type": "boolean" }, @@ -100416,13 +108027,26 @@ "type": "string" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "the name of the template", "length": 255, - "name": "deployasis", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "true if the template is available to all accounts; default is true", + "length": 255, + "name": "ispublic", "required": false, - "since": "4.15.1", "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": "32 or 64 bits support. 64 by default", "length": 255, @@ -100431,18 +108055,12 @@ "type": "integer" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", - "length": 255, - "name": "format", - "required": true, - "type": "string" - }, - { - "description": "true if this template requires HVM", + "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", "length": 255, - "name": "requireshvm", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "Register template for the project", @@ -100453,146 +108071,170 @@ "type": "uuid" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "isfeatured", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "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": "isextractable", + "name": "checksum", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the target hypervisor for the template", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "deployasis", + "required": false, + "since": "4.15.1", + "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": "true if this template is a featured template, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" }, { - "description": "the ID of the zone the template is to be hosted on", + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "directdownload", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "zoneids", - "related": "createZone,listZones", + "name": "isdynamicallyscalable", "required": false, - "type": "list" + "type": "boolean" } ], "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "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 template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, - {}, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, + {}, { - "description": "the status of the template", - "name": "status", + "description": "the template name", + "name": "name", "type": "string" }, { - "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": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { @@ -100601,116 +108243,64 @@ "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "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": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, - {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "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", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { @@ -100718,19 +108308,29 @@ "name": "physicalsize", "type": "long" }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, { "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", "name": "deployasis", "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { @@ -100739,68 +108339,105 @@ "type": "map" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "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": "checksum of the template", - "name": "checksum", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the template name", - "name": "name", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag 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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "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": "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" } ] @@ -100820,6 +108457,12 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -100835,12 +108478,6 @@ "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" } ] }, @@ -100856,6 +108493,13 @@ "required": true, "type": "string" }, + { + "description": "stratosphere ssp api username", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, { "description": "stratosphere ssp api password", "length": 255, @@ -100878,13 +108522,6 @@ "required": true, "type": "uuid" }, - { - "description": "stratosphere ssp api username", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, { "description": "stratosphere ssp tenant uuid", "length": 255, @@ -100896,26 +108533,26 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "zone which this ssp controls", - "name": "zoneid", + "description": "server id of the stratosphere ssp server", + "name": "hostid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "url of ssp endpoint", + "name": "url", "type": "string" }, {}, { - "description": "server id of the stratosphere ssp server", - "name": "hostid", + "description": "zone which this ssp controls", + "name": "zoneid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "name", @@ -100923,8 +108560,8 @@ "type": "string" }, { - "description": "url of ssp endpoint", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -100944,23 +108581,23 @@ } ], "response": [ + {}, {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -100973,21 +108610,6 @@ "isasync": false, "name": "createStoragePool", "params": [ - { - "description": "the Zone ID for the storage pool", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the tags for the storage pool", - "length": 255, - "name": "tags", - "required": false, - "type": "string" - }, { "description": "the Pod ID for the storage pool", "length": 255, @@ -100997,18 +108619,18 @@ "type": "uuid" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "bytes CloudStack can provision from this storage pool", "length": 255, - "name": "capacityiops", + "name": "capacitybytes", "required": false, "type": "long" }, { - "description": "the scope of the storage: cluster or zone", + "description": "the details for the storage pool", "length": 255, - "name": "scope", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", @@ -101017,13 +108639,6 @@ "required": false, "type": "string" }, - { - "description": "the storage provider name", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, { "description": "whether the storage should be managed by CloudStack", "length": 255, @@ -101032,19 +108647,26 @@ "type": "boolean" }, { - "description": "the name for the storage pool", + "description": "the URL of the storage pool", "length": 255, - "name": "name", + "name": "url", "required": true, "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": "IOPS CloudStack can provision from this storage pool", + "length": 255, + "name": "capacityiops", + "required": false, + "type": "long" + }, { "description": "the cluster ID for the storage pool", "length": 255, @@ -101054,26 +108676,41 @@ "type": "uuid" }, { - "description": "the details for the storage pool", + "description": "the tags for the storage pool", "length": 255, - "name": "details", + "name": "tags", "required": false, - "type": "map" + "type": "string" }, { - "description": "bytes CloudStack can provision from this storage pool", + "description": "the scope of the storage: cluster or zone", "length": 255, - "name": "capacitybytes", + "name": "scope", "required": false, - "type": "long" + "type": "string" + }, + { + "description": "the Zone ID for the storage pool", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the name for the storage pool", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { "description": "the host's currently used disk size", @@ -101081,15 +108718,14 @@ "type": "long" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, - {}, { - "description": "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 hypervisor type of the storage pool", @@ -101097,44 +108733,60 @@ "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the storage pool path", + "name": "path", "type": "string" }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, { "description": "the ID of the storage pool", "name": "id", "type": "string" }, + {}, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" + }, + { + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { "description": "the storage pool type", @@ -101147,70 +108799,55 @@ "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, + {}, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the 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 name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "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": "the name of the storage pool", - "name": "name", - "type": "string" - }, - { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" - }, { "description": "the storage pool capabilities", "name": "storagecapabilities", "type": "map" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" } ] }, @@ -101227,11 +108864,11 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of the volume", @@ -101242,28 +108879,29 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "cancelStorageMaintenance,enableStorageMaintenance", "response": [ { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, + {}, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { @@ -101271,11 +108909,17 @@ "name": "type", "type": "string" }, + {}, { - "description": "the storage pool path", - "name": "path", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, { "description": "the scope of the storage pool", "name": "scope", @@ -101287,111 +108931,188 @@ "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, { "description": "the date and time the storage pool was created", "name": "created", "type": "date" }, - {}, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the 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": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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": "the name of the storage pool", - "name": "name", + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "the storage pool path", + "name": "path", "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": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" - }, + } + ] + }, + { + "description": "create Tungsten-Fabric tag", + "isasync": true, + "name": "createTungstenFabricTag", + "params": [ { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "Tungsten-Fabric tag type", + "length": 255, + "name": "tagtype", + "required": true, "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric tag value", + "length": 255, + "name": "tagvalue", + "required": true, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "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": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, + {}, + {}, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" } ] }, @@ -101401,45 +109122,51 @@ "name": "addOpenDaylightController", "params": [ { - "description": "Credential to access the OpenDaylight API", + "description": "Api URL of the OpenDaylight Controller.", "length": 255, - "name": "password", + "name": "url", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "Username to access the OpenDaylight API", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "username", "required": true, - "type": "uuid" + "type": "string" }, { - "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": "Api URL of the OpenDaylight Controller.", + "description": "the Physical Network ID", "length": 255, - "name": "url", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ + { + "description": "the username to authenticate to the controller", + "name": "username", + "type": "string" + }, + {}, { "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 physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -101448,13 +109175,48 @@ "type": "string" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the url of the controller api", + "name": "url", "type": "string" }, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "delete Tungsten-Fabric firewall rule", + "isasync": true, + "name": "deleteTungstenFabricFirewallRule", + "params": [ + { + "description": "the uuid of Tungsten-Fabric firewall rule", + "length": 255, + "name": "firewallruleuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, @@ -101465,8 +109227,13 @@ }, {}, { - "description": "the url of the controller api", - "name": "url", + "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" } ] @@ -101476,6 +109243,20 @@ "isasync": false, "name": "createZone", "params": [ + { + "description": "true if local storage offering enabled, false otherwise", + "length": 255, + "name": "localstorageenabled", + "required": false, + "type": "boolean" + }, + { + "description": "network type of the zone, can be Basic or Advanced", + "length": 255, + "name": "networktype", + "required": true, + "type": "string" + }, { "description": "Network domain name for the networks in the zone", "length": 255, @@ -101484,40 +109265,40 @@ "type": "string" }, { - "description": "the first DNS for the Zone", + "description": "the name of the Zone", "length": 255, - "name": "dns1", + "name": "name", "required": true, "type": "string" }, { - "description": "the ID of the containing domain, null for public zones", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "ip6dns2", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "the first DNS for the Zone", "length": 255, - "name": "internaldns1", + "name": "dns1", "required": true, "type": "string" }, { - "description": "Allocation state of this Zone for allocation of new resources", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "allocationstate", + "name": "ip6dns1", "required": false, "type": "string" }, { - "description": "network type of the zone, can be Basic or Advanced", + "description": "true if the zone is an edge zone, false otherwise", "length": 255, - "name": "networktype", - "required": true, - "type": "string" + "name": "isedge", + "required": false, + "since": "4.18.0", + "type": "boolean" }, { "description": "the guest CIDR address for the Zone", @@ -101527,33 +109308,27 @@ "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "the ID of the containing domain, null for public zones", "length": 255, - "name": "ip6dns2", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the second DNS for the Zone", + "description": "Allocation state of this Zone for allocation of new resources", "length": 255, - "name": "dns2", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the name of the Zone", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "name", + "name": "internaldns1", "required": true, "type": "string" }, - { - "description": "true if local storage offering enabled, false otherwise", - "length": 255, - "name": "localstorageenabled", - "required": false, - "type": "boolean" - }, { "description": "true if network is security group enabled, false otherwise", "length": 255, @@ -101562,16 +109337,16 @@ "type": "boolean" }, { - "description": "the second internal DNS for the Zone", + "description": "the second DNS for the Zone", "length": 255, - "name": "internaldns2", + "name": "dns2", "required": false, "type": "string" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "ip6dns1", + "name": "internaldns2", "required": false, "type": "string" } @@ -101579,58 +109354,67 @@ "related": "listZones", "response": [ { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the allocation state of the cluster", + "name": "allocationstate", "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 public interfaces", + "name": "routerpublicinterfacemaxmtu", "type": "integer" }, + { + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, - {}, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -101639,8 +109423,8 @@ "type": "long" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { @@ -101648,52 +109432,37 @@ "name": "capacityused", "type": "long" }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, { "description": "the Zone name", "name": "zonename", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { "description": "the capacity currently in allocated", "name": "capacityallocated", "type": "long" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" } ], "type": "list" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "Zone name", - "name": "name", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { @@ -101702,67 +109471,68 @@ "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": "the name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, + {}, { - "description": "Zone description", - "name": "description", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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": "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": "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" }, { @@ -101771,41 +109541,41 @@ "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": "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" } ], "type": "set" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" }, { - "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" }, { @@ -101813,20 +109583,45 @@ "name": "id", "type": "string" }, + { + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the first DNS for the Zone", "name": "dns1", "type": "string" }, - {}, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + { + "description": "Zone description", + "name": "description", + "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, { "description": "true if security groups support is enabled, false otherwise", "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" } ] @@ -101848,29 +109643,18 @@ "related": "listCiscoNexusVSMs", "response": [ { - "description": "device name", - "name": "vsmdevicename", - "type": "string" - }, - {}, - { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" - }, - { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", "type": "int" }, { @@ -101879,33 +109663,29 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "device id of the Cisco N1KV VSM device", "name": "vsmdeviceid", "type": "string" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -101913,10 +109693,25 @@ "name": "vsmdomainid", "type": "string" }, + { + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" + }, {}, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" + }, + { + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", + "type": "string" + }, + { + "description": "device name", + "name": "vsmdevicename", "type": "string" } ] @@ -101927,108 +109722,108 @@ "name": "createStorageNetworkIpRange", "params": [ { - "description": "the netmask for storage network", + "description": "the gateway for storage network", "length": 255, - "name": "netmask", + "name": "gateway", "required": true, "type": "string" }, { - "description": "UUID of pod where the ip range belongs to", + "description": "the ending IP address", + "length": 255, + "name": "endip", + "required": false, + "type": "string" + }, + { + "description": "the netmask for storage network", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "netmask", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means you network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly reterive bridge from pyhsical network traffic type table", + "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table", "length": 255, "name": "vlan", "required": false, "type": "integer" }, { - "description": "the beginning IP address", + "description": "UUID of pod where the ip range belongs to", "length": 255, - "name": "startip", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": true, - "type": "string" - }, - { - "description": "the ending IP address", - "length": 255, - "name": "endip", - "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the gateway for storage network", + "description": "the beginning IP address", "length": 255, - "name": "gateway", + "name": "startip", "required": true, "type": "string" } ], "related": "", "response": [ - { - "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", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "the start ip of the storage network IP range", + "name": "startip", + "type": "string" + }, { "description": "the Pod uuid for the storage network IP range", "name": "podid", "type": "string" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "the 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 end ip of the storage network IP range", + "name": "endip", + "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" - } + }, + {}, + {} ], "since": "3.0.0" }, @@ -102037,13 +109832,6 @@ "isasync": false, "name": "listDomainChildren", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "list children domain by parent domain ID.", "length": 255, @@ -102053,39 +109841,39 @@ "type": "uuid" }, { - "description": "list children domains by name", + "description": "List by keyword", "length": 255, - "name": "name", + "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", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", + "description": "list children domains by name", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "flag to display the resource icon for domains", @@ -102093,49 +109881,32 @@ "name": "showicon", "required": false, "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "listDomains", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the date when this domain was created", - "name": "created", - "type": "date" - }, - { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "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 total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" }, { "description": "the total number of public ip addresses allocated for this domain", @@ -102143,19 +109914,13 @@ "type": "long" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "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 primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { @@ -102164,23 +109929,18 @@ "type": "long" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "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 public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { @@ -102189,14 +109949,14 @@ "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { "description": "the total number of public ip addresses available for this domain to acquire", @@ -102204,54 +109964,53 @@ "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "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 number of networks the domain can own", - "name": "networklimit", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, - {}, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the domain", - "name": "id", - "type": "string" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { @@ -102260,19 +110019,24 @@ "type": "long" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" }, { "description": "the total number of vpcs the domain can own", @@ -102280,8 +110044,8 @@ "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, { @@ -102290,24 +110054,35 @@ "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, + {}, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" }, { "description": "the total memory (in MB) the domain can own", @@ -102315,43 +110090,63 @@ "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "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 number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" } ] @@ -102396,6 +110191,13 @@ "isasync": true, "name": "assignToGlobalLoadBalancerRule", "params": [ + { + "description": "Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'", + "length": 255, + "name": "gslblbruleweightsmap", + "required": false, + "type": "map" + }, { "description": "the list load balancer rules that will be assigned to global load balancer rule", "length": 255, @@ -102411,38 +110213,31 @@ "related": "", "required": true, "type": "uuid" - }, - { - "description": "Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'", - "length": 255, - "name": "gslblbruleweightsmap", - "required": false, - "type": "map" } ], "response": [ { - "description": "the UUID of the latest async job acting on 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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {} + } ] }, { @@ -102450,13 +110245,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, @@ -102464,31 +110252,43 @@ "related": "configureOvsElement", "required": true, "type": "uuid" + }, + { + "description": "Enabled/Disabled the service provider", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" } ], "related": "", "response": [ + { + "description": "the physical network service provider id of the provider", + "name": "nspid", + "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 project id of the ipaddress", - "name": "projectid", + "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 associated with the provider", + "name": "domain", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { "description": "the account associated with the provider", @@ -102496,29 +110296,24 @@ "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of the ovs", - "name": "id", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" - }, - { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" } ] }, @@ -102527,6 +110322,13 @@ "isasync": false, "name": "addImageStoreS3", "params": [ + { + "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", + "length": 255, + "name": "s3signer", + "required": false, + "type": "string" + }, { "description": "Socket timeout (milliseconds)", "length": 255, @@ -102535,11 +110337,11 @@ "type": "integer" }, { - "description": "Connection TTL (milliseconds)", + "description": "Use HTTPS instead of HTTP", "length": 255, - "name": "connectionttl", + "name": "usehttps", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "Connection timeout (milliseconds)", @@ -102548,13 +110350,6 @@ "required": false, "type": "integer" }, - { - "description": "S3 secret key", - "length": 255, - "name": "secretkey", - "required": true, - "type": "string" - }, { "description": "S3 endpoint", "length": 255, @@ -102562,13 +110357,6 @@ "required": true, "type": "string" }, - { - "description": "Use HTTPS instead of HTTP", - "length": 255, - "name": "usehttps", - "required": false, - "type": "boolean" - }, { "description": "Name of the storage bucket", "length": 255, @@ -102577,10 +110365,17 @@ "type": "string" }, { - "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", + "description": "Maximum number of times to retry on error", "length": 255, - "name": "s3signer", + "name": "maxerrorretry", "required": false, + "type": "integer" + }, + { + "description": "S3 secret key", + "length": 255, + "name": "secretkey", + "required": true, "type": "string" }, { @@ -102591,57 +110386,43 @@ "type": "string" }, { - "description": "Whether TCP keep-alive is used", + "description": "Connection TTL (milliseconds)", "length": 255, - "name": "usetcpkeepalive", + "name": "connectionttl", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "Maximum number of times to retry on error", + "description": "Whether TCP keep-alive is used", "length": 255, - "name": "maxerrorretry", + "name": "usetcpkeepalive", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "listImageStores", "response": [ - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" - }, + {}, { "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 protocol of the image store", "name": "protocol", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { "description": "defines if store is read-only", @@ -102649,14 +110430,13 @@ "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the url of the image store", + "name": "url", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the image store", + "name": "name", "type": "string" }, { @@ -102665,19 +110445,34 @@ "type": "boolean" }, { - "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 name of the image store", - "name": "name", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + { + "description": "the provider name of the image store", + "name": "providername", "type": "string" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" } ], "since": "4.7.0" @@ -102694,84 +110489,84 @@ "required": true, "type": "string" }, - { - "description": "Zone to upload certificate", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, { "description": "(optional) the host ID to upload certificate", "length": 255, "name": "hostid", - "related": "addBaremetalHost,reconnectHost", + "related": "reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "Name for the uploaded certificate", - "length": 255, - "name": "name", + "description": "SSL certificate", + "length": 65535, + "name": "certificate", "required": true, "type": "string" }, { - "description": "SSL certificate", - "length": 65535, - "name": "certificate", + "description": "Zone to upload certificate", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Name for the uploaded certificate", + "length": 255, + "name": "name", "required": true, "type": "string" } ], "related": "", "response": [ + {}, { - "description": "the direct download certificate id", - "name": "id", + "description": "the direct download certificate issuer", + "name": "validity", "type": "string" }, + {}, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "issuer", + "description": "the direct download certificate id", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the direct download certificate issuer", + "name": "issuer", + "type": "string" }, - {}, { "description": "the zone id where the certificate is uploaded", "name": "zoneid", "type": "string" }, { - "description": "the direct download certificate subject", - "name": "subject", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the direct download certificate version", - "name": "version", + "description": "the zone name where the certificate is uploaded", + "name": "zonename", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "validity", + "description": "the direct download certificate version", + "name": "version", "type": "string" }, { @@ -102780,9 +110575,9 @@ "type": "list" }, { - "description": "the direct download certificate serial num", - "name": "serialnum", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the direct download certificate alias", @@ -102790,8 +110585,8 @@ "type": "string" }, { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", "type": "string" } ], @@ -102802,6 +110597,57 @@ "isasync": true, "name": "importUnmanagedInstance", "params": [ + { + "description": "used to specify the custom parameters.", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "VM nic to ip address mapping using keys nic, ip4Address", + "length": 255, + "name": "nicipaddresslist", + "required": false, + "type": "map" + }, + { + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, + "type": "uuid" + }, + { + "description": "VM nic to network id mapping using keys nic and network", + "length": 255, + "name": "nicnetworklist", + "required": false, + "type": "map" + }, + { + "description": "import instance to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "length": 255, + "name": "migrateallowed", + "required": false, + "type": "boolean" + }, + { + "description": "VM is imported despite some of its NIC's MAC addresses are already present", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, { "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, @@ -102810,139 +110656,449 @@ "type": "map" }, { - "description": "the display name of the instance", - "length": 255, - "name": "displayname", - "required": false, + "description": "the host name of the instance", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" + }, + { + "description": "import instance for the project", + "length": 255, + "name": "projectid", + "related": "activateProject", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" + }, + { + "description": "the display name of the instance", + "length": 255, + "name": "displayname", + "required": false, + "type": "string" + }, + { + "description": "the hypervisor name of the instance", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the ID of the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + } + ], + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "response": [ + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "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 name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the 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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the template for the virtual machine", - "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": false, - "type": "uuid" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "import instance to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "VM is imported despite some of its NIC's MAC addresses are already present", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the hypervisor name of the instance", - "length": 255, - "name": "name", - "required": true, + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "VM nic to network id mapping using keys nic and network", - "length": 255, - "name": "nicnetworklist", - "required": false, - "type": "map" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "used to specify the custom parameters.", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", - "length": 255, - "name": "migrateallowed", - "required": false, - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "import instance for the project", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the ID of the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the host name of the instance", - "length": 255, - "name": "hostname", - "required": false, + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", - "length": 255, - "name": "nicipaddresslist", - "required": false, - "type": "map" - } - ], - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "response": [ + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, { "description": "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", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { @@ -102950,8 +111106,8 @@ "name": "affinitygroup", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { @@ -102959,34 +111115,29 @@ "name": "description", "type": "string" }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, { "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the ID of the affinity group", + "name": "id", "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 ID of the affinity group", - "name": "id", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { @@ -102998,54 +111149,84 @@ "description": "the project ID of the affinity group", "name": "projectid", "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" } ], "type": "set" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + {}, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "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", "type": "string" }, - {}, { - "description": "the name of the virtual machine", - "name": "name", + "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": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { @@ -103054,63 +111235,154 @@ "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, - {}, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the 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 ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "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 name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the domain associated with the tag", + "name": "domain", "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "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 protocol of the security group rule", - "name": "protocol", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", @@ -103122,8 +111394,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" }, { @@ -103131,90 +111403,11 @@ "name": "account", "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": "the domain associated with the tag", "name": "domain", "type": "string" }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - } - ], - "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 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 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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", @@ -103226,23 +111419,8 @@ "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": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -103251,27 +111429,27 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the type of the ICMP message response", @@ -103279,18 +111457,13 @@ "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 id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -103304,249 +111477,153 @@ "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 project id of the group", - "name": "projectid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "tag value", - "name": "value", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "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", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "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 ID of the domain associated with the tag", + "description": "the domain ID of the security group", "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", + "description": "the domain name of the security group", "name": "domain", "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" } ], "type": "set" }, - { - "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 group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - {}, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { @@ -103555,48 +111632,23 @@ "type": "boolean" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { @@ -103605,28 +111657,18 @@ "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -103635,249 +111677,148 @@ "type": "long" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "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": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "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 netmask of the nic", - "name": "netmask", - "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the 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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - } - ], - "type": "set" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "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": "ssh key-pairs", - "name": "keypairs", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "Lists System VM stats", + "isasync": false, + "name": "listSystemVmsUsageHistory", + "params": [ + { + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "the ID of the system VM.", + "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", + "required": false, + "type": "uuid" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the IDs of the system VMs, mutually exclusive with id.", + "length": 255, + "name": "ids", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": false, + "type": "list" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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" + } + ], + "related": "", + "response": [ + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the list of VM stats", + "name": "stats", + "type": "list" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the 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", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" } ], - "since": "4.14.0" + "since": "4.18.0" }, { "description": "Deletes a IPv6 firewall rule", @@ -103894,17 +111835,16 @@ } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -103915,7 +111855,8 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -103931,16 +111872,24 @@ "type": "list" }, { - "description": "the name of the physical network", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "name", - "required": true, + "name": "networkspeed", + "required": false, "type": "string" }, { - "description": "the VLAN for the physical network", + "description": "domain ID of the account owning a physical network", "length": 255, - "name": "vlan", + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", + "length": 255, + "name": "broadcastdomainrange", "required": false, "type": "string" }, @@ -103953,18 +111902,17 @@ "type": "uuid" }, { - "description": "domain ID of the account owning a physical network", + "description": "the VLAN for the physical network", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "vlan", "required": false, - "type": "uuid" + "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 name of the physical network", "length": 255, - "name": "broadcastdomainrange", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -103973,13 +111921,6 @@ "name": "isolationmethods", "required": false, "type": "list" - }, - { - "description": "the speed for the physical network[1G/10G]", - "length": 255, - "name": "networkspeed", - "required": false, - "type": "string" } ], "related": "", @@ -103989,19 +111930,15 @@ "name": "state", "type": "string" }, - { - "description": "comma separated tag", - "name": "tags", - "type": "string" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { @@ -104010,47 +111947,51 @@ "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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": "name of the physical network", - "name": "name", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, - {}, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the uuid of the physical network", "name": "id", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "name of the physical network", + "name": "name", "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -104059,6 +112000,13 @@ "isasync": false, "name": "listAutoScaleVmGroups", "params": [ + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -104067,43 +112015,43 @@ "type": "string" }, { - "description": "the ID of the loadbalancer", + "description": "the ID of the profile", "length": 255, - "name": "lbruleid", - "related": "", + "name": "vmprofileid", + "related": "createAutoScaleVmProfile", "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": "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": "listDomains", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the policy", + "description": "the ID of the loadbalancer", "length": 255, - "name": "policyid", + "name": "lbruleid", "related": "", "required": false, "type": "uuid" }, { - "description": "the ID of the autoscale vm group", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "id", - "related": "listAutoScaleVmGroups", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -104114,113 +112062,125 @@ "type": "uuid" }, { - "description": "the ID of the profile", + "description": "List by keyword", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the autoscale vm group", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "listAutoScaleVmGroups", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the availability zone ID", + "description": "the name of the autoscale vmgroup", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the ID of the policy", "length": 255, - "name": "listall", + "name": "policyid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "", "response": [ { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the name of the autoscale vm group ", + "name": "name", + "type": "string" }, + {}, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the domain ID of the vm profile", - "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 autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the project id vm profile", + "description": "the project id of the vm group", "name": "projectid", "type": "string" }, { - "description": "the domain name of the vm profile", + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" + }, + { + "description": "the domain name of the vm group", "name": "domain", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { @@ -104229,30 +112189,74 @@ "type": "list" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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 lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", + "type": "string" + }, + { + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" + }, + { + "description": "the date when this vm group was created", + "name": "created", + "type": "date" + }, + { + "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 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 account owning the instance group", - "name": "account", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" } ] @@ -104262,13 +112266,6 @@ "isasync": true, "name": "createFirewallRule", "params": [ - { - "description": "the ending port of firewall rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, { "description": "type of firewallrule: system/user", "length": 255, @@ -104276,14 +112273,6 @@ "required": false, "type": "string" }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, @@ -104299,6 +112288,21 @@ "required": true, "type": "uuid" }, + { + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, @@ -104314,16 +112318,16 @@ "type": "integer" }, { - "description": "the starting port of firewall rule", + "description": "the ending port of firewall rule", "length": 255, - "name": "startport", + "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" } @@ -104331,38 +112335,29 @@ "related": "updateEgressFirewallRule", "response": [ { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, + {}, { "description": "is rule for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { @@ -104371,24 +112366,19 @@ "type": "integer" }, { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "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": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { "description": "the starting port of firewall rule's port range", @@ -104396,14 +112386,29 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 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": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { @@ -104411,13 +112416,8 @@ "name": "tags", "response": [ { - "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" }, { @@ -104426,18 +112426,18 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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": "tag key name", + "name": "key", "type": "string" }, { @@ -104446,29 +112446,33 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "the ending port of firewall rule's port range", + "name": "endport", "type": "integer" - }, - {} + } ] }, { @@ -104477,18 +112481,19 @@ "name": "createVolume", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "an optional field, whether to display the volume to the end user or not.", "length": 255, - "name": "customid", + "name": "displayvolume", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the account associated with the disk volume. Must be used with the domainId parameter.", + "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "account", + "name": "diskofferingid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", @@ -104499,42 +112504,42 @@ "type": "uuid" }, { - "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.", + "description": "the project associated with the volume. Mutually exclusive with account parameter", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "activateProject", "required": false, "type": "uuid" }, { - "description": "an optional field, whether to display the volume to the end user or not.", + "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": "displayvolume", + "name": "virtualmachineid", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", + "description": "the account associated with the disk volume. Must be used with the domainId parameter.", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the availability zone", + "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "min iops", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "miniops", + "name": "customid", "required": false, - "type": "long" + "type": "string" }, { "description": "Arbitrary volume size", @@ -104544,17 +112549,17 @@ "type": "long" }, { - "description": "the project associated with the volume. Mutually exclusive with account parameter", + "description": "the ID of the availability zone", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "max iops", + "description": "min iops", "length": 255, - "name": "maxiops", + "name": "miniops", "required": false, "type": "long" }, @@ -104566,110 +112571,53 @@ "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": "max iops", "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", + "name": "maxiops", "required": false, - "type": "uuid" + "type": "long" } ], "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "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": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "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", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "the path of the volume", - "name": "path", - "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": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { @@ -104678,69 +112626,24 @@ "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, { "description": "name of the virtual machine", "name": "vmname", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "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": "the date the disk volume was created", + "name": "created", + "type": "date" }, { "description": "the domain associated with the disk volume", @@ -104748,52 +112651,42 @@ "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "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": "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": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -104807,18 +112700,18 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -104827,21 +112720,31 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { @@ -104850,39 +112753,39 @@ "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": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { "description": "ID of the snapshot from which this volume was created", @@ -104890,13 +112793,33 @@ "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { @@ -104905,29 +112828,79 @@ "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, {}, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "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": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { @@ -104936,34 +112909,70 @@ "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + {}, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "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": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" } ] }, @@ -104973,34 +112982,34 @@ "name": "listVMSnapshot", "params": [ { - "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", + "description": "the ID of the vm", "length": 255, - "name": "vmsnapshotids", - "related": "listVMSnapshot,createVMSnapshot", + "name": "virtualmachineid", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "required": false, - "since": "4.9", - "type": "list" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "The ID of the VM snapshot", "length": 255, - "name": "account", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "lists snapshot by snapshot name or display name", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -105010,33 +113019,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": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the ID of the vm", + "description": "state of the virtual machine snapshot", "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", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "lists snapshot by snapshot name or display name", "length": 255, - "name": "tags", + "name": "name", "required": false, - "type": "map" + "type": "string" }, { - "description": "state of the virtual machine snapshot", + "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", "length": 255, - "name": "state", + "name": "vmsnapshotids", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "string" + "since": "4.9", + "type": "list" }, { "description": "", @@ -105046,85 +113056,125 @@ "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isrecursive", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "activateProject", "required": false, "type": "uuid" }, { - "description": "The ID of the VM snapshot", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "createVMSnapshot", "response": [ - { - "description": "VM Snapshot type", - "name": "type", - "type": "string" - }, { "description": "the name of the vm snapshot", "name": "name", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, {}, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, { "description": "the create date of the vm snapshot", "name": "created", "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" }, - {}, { "description": "the project id of the vpn", "name": "projectid", "type": "string" }, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the parent displayName of the vm snapshot", + "name": "parentName", + "type": "string" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -105132,48 +113182,48 @@ "type": "string" }, { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", + "description": "the description of the vm snapshot", + "name": "description", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "indiates if this is current snapshot", - "name": "current", - "type": "boolean" + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" }, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "the Zone name of the vm snapshot", + "name": "zonename", "type": "string" }, { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "description": "the ID of the vm snapshot", + "name": "id", "type": "string" }, { - "description": "the display name of the vm snapshot", - "name": "displayname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the description of the vm snapshot", - "name": "description", + "description": "the parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "VM Snapshot type", + "name": "type", "type": "string" }, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { @@ -105181,62 +113231,11 @@ "name": "project", "type": "string" }, + {}, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "the display name of the vm snapshot", + "name": "displayname", + "type": "string" }, { "description": "the Zone ID of the vm snapshot", @@ -105244,14 +113243,24 @@ "type": "string" }, { - "description": "the ID of the vm snapshot", - "name": "id", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "hypervisortype" + }, + { + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" } ], "since": "4.2.0" @@ -105262,9 +113271,16 @@ "name": "updatePod", "params": [ { - "description": "the gateway for the Pod", + "description": "the starting IP address for the Pod", "length": 255, - "name": "gateway", + "name": "startip", + "required": false, + "type": "string" + }, + { + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", "required": false, "type": "string" }, @@ -105275,6 +113291,13 @@ "required": false, "type": "string" }, + { + "description": "the gateway for the Pod", + "length": 255, + "name": "gateway", + "required": false, + "type": "string" + }, { "description": "the ID of the Pod", "length": 255, @@ -105283,13 +113306,6 @@ "required": true, "type": "uuid" }, - { - "description": "the netmask of the Pod", - "length": 255, - "name": "netmask", - "required": false, - "type": "string" - }, { "description": "the ending IP address for the Pod", "length": 255, @@ -105298,66 +113314,34 @@ "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, - { - "description": "the starting IP address for the Pod", + "description": "the netmask of the Pod", "length": 255, - "name": "startip", + "name": "netmask", "required": false, "type": "string" } ], "related": "createManagementNetworkIpRange", "response": [ - {}, - { - "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 allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" - }, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, + {}, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", "type": "list" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { @@ -105365,35 +113349,40 @@ "name": "capacity", "response": [ { - "description": "the Zone ID", - "name": "zoneid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Pod name", - "name": "podname", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Cluster ID", + "name": "clusterid", + "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 capacity type", + "name": "type", + "type": "short" }, { - "description": "the capacity name", - "name": "name", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, { "description": "the Pod ID", "name": "podid", @@ -105405,19 +113394,14 @@ "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the percentage of capacity currently in use", @@ -105428,29 +113412,54 @@ "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" }, { "description": "the name of the Pod", "name": "name", "type": "string" }, + { + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" + }, + {}, + { + "description": "the ID of the Pod", + "name": "id", + "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 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", + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", "type": "list" }, { @@ -105458,33 +113467,33 @@ "name": "ipranges", "response": [ { - "description": "the ending IP for the range", - "name": "endip", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the gateway for the range", - "name": "gateway", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" } ], @@ -105497,6 +113506,21 @@ "isasync": true, "name": "moveNetworkAclItem", "params": [ + { + "description": "The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list.", + "length": 255, + "name": "previousaclruleid", + "required": false, + "type": "string" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, { "description": "The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list.", "length": 255, @@ -105511,34 +113535,19 @@ "required": true, "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.", - "length": 255, - "name": "previousaclruleid", - "required": false, - "type": "string" - }, { "description": "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).", "length": 255, "name": "aclconsistencyhash", "required": false, "type": "string" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" } ], "related": "", "response": [ { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { @@ -105547,58 +113556,33 @@ "type": "integer" }, { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "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": "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 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": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, { "description": "Action of ACL Item. Allow/Deny", "name": "action", "type": "string" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -105606,69 +113590,79 @@ "name": "tags", "response": [ { - "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" }, { - "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag 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 ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, - {}, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "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": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + {}, { "description": "the starting port of ACL's port range", "name": "startport", @@ -105676,9 +113670,24 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + { + "description": "the ID of the ACL Item", + "name": "id", + "type": "string" } ] }, @@ -105687,14 +113696,6 @@ "isasync": true, "name": "attachIso", "params": [ - { - "description": "the ID of the ISO file", - "length": 255, - "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" - }, { "description": "If true, ejects existing ISO before attaching on VMware. Default: false", "length": 255, @@ -105703,6 +113704,14 @@ "since": "4.15.1", "type": "boolean" }, + { + "description": "the ID of the ISO file", + "length": 255, + "name": "id", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" + }, { "description": "the ID of the virtual machine", "length": 255, @@ -105715,176 +113724,28 @@ "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "response": [ { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - {}, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "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 name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -105894,6 +113755,11 @@ "name": "key", "type": "string" }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "tag value", "name": "value", @@ -105905,13 +113771,8 @@ "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -105920,46 +113781,31 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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" } ], "type": "set" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -105973,113 +113819,56 @@ "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", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "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", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the 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 ", @@ -106087,18 +113876,23 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "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 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", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -106106,13 +113900,18 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -106120,24 +113919,19 @@ "name": "customer", "type": "string" }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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" }, { @@ -106146,13 +113940,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": "tag value", + "name": "value", "type": "string" } ], @@ -106164,9 +113958,9 @@ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "security group name", @@ -106174,70 +113968,152 @@ "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the 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 project name where tag belongs to", + "name": "project", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the group", + "name": "project", "type": "string" }, { "description": "the domain name of the security group", "name": "domain", "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the virtual machine", - "name": "id", + "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 name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, + {}, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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 account associated with the virtual machine", - "name": "account", + "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", + "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": "OS name of the vm", - "name": "osdisplayname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { @@ -106246,8 +114122,43 @@ "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the 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": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { @@ -106256,131 +114167,368 @@ "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "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": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "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 ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { @@ -106389,196 +114537,162 @@ "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + {}, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "tag value", + "name": "value", "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" } ], "type": "set" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID of the 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": "the UUID of the latest async job acting on this object", @@ -106586,13 +114700,8 @@ "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -106601,79 +114710,24 @@ "type": "date" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the 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" } ] }, @@ -106692,11 +114746,7 @@ } ], "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", @@ -106704,15 +114754,19 @@ }, {}, { - "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" } ] }, @@ -106721,6 +114775,13 @@ "isasync": false, "name": "listBaremetalDhcp", "params": [ + { + "description": "Type of DHCP device", + "length": 255, + "name": "dhcpservertype", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -106737,25 +114798,18 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "Type of DHCP device", + "description": "List by keyword", "length": 255, - "name": "dhcpservertype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "DHCP server device ID", @@ -106767,16 +114821,23 @@ ], "related": "", "response": [ + {}, { - "description": "url", - "name": "url", + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "url", + "name": "url", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -106784,24 +114845,17 @@ }, { "description": "name of the provider", - "name": "dhcpservertype", + "name": "provider", "type": "string" }, - {}, { - "description": "device id of ", - "name": "id", + "description": "name of the provider", + "name": "dhcpservertype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "name of the provider", - "name": "provider", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" } ] @@ -106823,146 +114877,146 @@ "related": "cancelStorageMaintenance", "response": [ { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, + {}, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the 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 name of the storage pool", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the storage pool type", - "name": "type", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the 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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the Zone name of the storage pool", + "name": "zonename", "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 name of the cluster for the storage pool", - "name": "clustername", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, - {}, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, + {}, { - "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" } ] }, @@ -106979,24 +115033,19 @@ "type": "string" }, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", - "name": "searchbase", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "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": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", "type": "string" }, { @@ -107004,20 +115053,25 @@ "name": "queryfilter", "type": "string" }, - {}, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "description": "DN password", - "name": "bindpass", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", + "name": "searchbase", "type": "string" }, + {}, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "DN password", + "name": "bindpass", "type": "string" } ], @@ -107029,39 +115083,46 @@ "name": "createUser", "params": [ { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "description": "firstname", "length": 255, - "name": "password", + "name": "firstname", "required": true, "type": "string" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "email", + "length": 255, + "name": "email", "required": true, "type": "string" }, { - "description": "Unique username.", + "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": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "description": "Unique username.", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "name": "username", + "required": true, + "type": "string" }, { - "description": "email", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "email", - "required": true, + "name": "timezone", + "required": false, "type": "string" }, { @@ -107079,81 +115140,89 @@ "type": "string" }, { - "description": "firstname", + "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": "firstname", + "name": "account", "required": true, "type": "string" - }, - { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": false, - "type": "string" } ], "related": "getUser", "response": [ + { + "description": "the 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 type of the role", - "name": "roletype", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the user ID", + "name": "id", "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": "the account type of the user", - "name": "accounttype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { @@ -107162,61 +115231,56 @@ "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the 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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "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" - } + }, + {} ] }, { @@ -107234,37 +115298,43 @@ ], "related": "", "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "version of CloudStack the api was introduced in", - "name": "since", - "type": "string" - }, - { - "description": "api response fields", - "name": "response", + "description": "the list params the api accepts", + "name": "params", "response": [ { - "description": "response field type", - "name": "type", + "description": "length of the parameter", + "name": "length", + "type": "int" + }, + { + "description": "true if this parameter is required for the api request", + "name": "required", + "type": "boolean" + }, + { + "description": "version of CloudStack the api was introduced in", + "name": "since", "type": "string" }, { - "description": "description of the api response field", - "name": "description", + "description": "comma separated related apis to get the parameter", + "name": "related", "type": "string" }, { - "description": "api response fields", - "name": "response", - "type": "set" + "description": "parameter type", + "name": "type", + "type": "string" }, { - "description": "the name of the api response field", + "description": "description of the api parameter", + "name": "description", + "type": "string" + }, + { + "description": "the name of the api parameter", "name": "name", "type": "string" } @@ -107272,78 +115342,72 @@ "type": "set" }, { - "description": "comma separated related apis", - "name": "related", + "description": "the UUID of the latest async job acting on 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 api command", "name": "name", "type": "string" }, { - "description": "description of the api", - "name": "description", + "description": "version of CloudStack the api was introduced in", + "name": "since", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "response field type", + "name": "type", "type": "string" }, + {}, { - "description": "response field type", - "name": "type", + "description": "description of the api", + "name": "description", "type": "string" }, { - "description": "true if api is asynchronous", - "name": "isasync", - "type": "boolean" + "description": "comma separated related apis", + "name": "related", + "type": "string" }, - {}, - {}, { - "description": "the list params the api accepts", - "name": "params", + "description": "api response fields", + "name": "response", "response": [ { - "description": "comma separated related apis to get the parameter", - "name": "related", - "type": "string" - }, - { - "description": "description of the api parameter", - "name": "description", + "description": "the name of the api response field", + "name": "name", "type": "string" }, { - "description": "parameter type", + "description": "response field type", "name": "type", "type": "string" }, { - "description": "the name of the api parameter", - "name": "name", - "type": "string" - }, - { - "description": "true if this parameter is required for the api request", - "name": "required", - "type": "boolean" + "description": "api response fields", + "name": "response", + "type": "set" }, { - "description": "version of CloudStack the api was introduced in", - "name": "since", + "description": "description of the api response field", + "name": "description", "type": "string" - }, - { - "description": "length of the parameter", - "name": "length", - "type": "int" } ], "type": "set" + }, + { + "description": "true if api is asynchronous", + "name": "isasync", + "type": "boolean" } ], "since": "4.1.0" @@ -107363,17 +115427,11 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -107384,6 +115442,12 @@ "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, {} ] }, @@ -107392,14 +115456,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, @@ -107407,48 +115463,63 @@ "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 project name", - "name": "project", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the public IP address", + "name": "publicip", "type": "string" }, + {}, { - "description": "the owner", - "name": "account", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the owner", + "name": "account", + "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -107456,27 +115527,20 @@ "name": "vpcid", "type": "string" }, - {}, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the domain id of the owner", + "name": "domainid", "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" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" } ] }, @@ -107486,18 +115550,19 @@ "name": "createVMSnapshot", "params": [ { - "description": "snapshot memory if true", + "description": "The display name of the snapshot", "length": 255, - "name": "snapshotmemory", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The description of the snapshot", + "description": "The ID of the vm", "length": 255, - "name": "description", - "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", + "required": true, + "type": "uuid" }, { "description": "quiesce vm if true", @@ -107507,87 +115572,71 @@ "type": "boolean" }, { - "description": "The display name of the snapshot", + "description": "snapshot memory if true", "length": 255, - "name": "name", + "name": "snapshotmemory", "required": false, - "type": "string" + "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", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the vm snapshot", - "name": "name", + "description": "the parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" - }, - { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "hypervisortype" + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" }, { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "VM Snapshot type", + "name": "type", "type": "string" }, - {}, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", + "description": "the ID of the vm snapshot", + "name": "id", "type": "string" }, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the display name of the vm snapshot", - "name": "displayname", + "description": "the description of the vm snapshot", + "name": "description", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "hypervisortype" }, + {}, { "description": "the 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 associated with the disk volume", - "name": "domain", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { @@ -107595,28 +115644,28 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the 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": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -107625,8 +115674,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -107638,65 +115692,75 @@ "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": "indiates if this is current snapshot", - "name": "current", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the description of the vm snapshot", - "name": "description", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, - {}, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "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 vm name of the vm snapshot", "name": "virtualmachinename", "type": "string" }, + { + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" + }, { "description": "the parent displayName of the vm snapshot", "name": "parentName", "type": "string" }, { - "description": "the ID of the vm snapshot", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "VM Snapshot type", - "name": "type", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Zone name of the vm snapshot", + "name": "zonename", "type": "string" + }, + { + "description": "the display name of the vm snapshot", + "name": "displayname", + "type": "string" + }, + { + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" } ], "since": "4.2.0" @@ -107706,13 +115770,6 @@ "isasync": true, "name": "addResourceDetail", "params": [ - { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" - }, { "description": "pass false if you want this detail to be disabled for the regular user. True by default", "length": 255, @@ -107721,6 +115778,13 @@ "since": "4.4", "type": "boolean" }, + { + "description": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" + }, { "description": "Map of (key/value pairs)", "length": 255, @@ -107737,26 +115801,26 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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" } ] @@ -107766,6 +115830,14 @@ "isasync": false, "name": "listVpnUsers", "params": [ + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -107775,34 +115847,32 @@ "type": "uuid" }, { - "description": "the username of the vpn user.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "username", + "name": "listall", "required": false, - "type": "string" + "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": "The uuid of the Vpn user", + "description": "", "length": 255, - "name": "id", - "related": "addVpnUser,listVpnUsers", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -107812,60 +115882,43 @@ "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": "", + "description": "the username of the vpn user.", "length": 255, - "name": "page", + "name": "username", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "The uuid of the Vpn user", "length": 255, - "name": "pagesize", + "name": "id", + "related": "addVpnUser,listVpnUsers", "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" } ], "related": "addVpnUser", "response": [ - {}, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "the vpn userID", - "name": "id", - "type": "string" - }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the username of the vpn user", - "name": "username", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { @@ -107873,6 +115926,7 @@ "name": "domainid", "type": "string" }, + {}, { "description": "the state of the Vpn User", "name": "state", @@ -107880,19 +115934,29 @@ }, {}, { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "the username of the vpn user", + "name": "username", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the vpn userID", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -107911,11 +115975,10 @@ } ], "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, { @@ -107923,15 +115986,16 @@ "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.2.0" @@ -107951,12 +116015,17 @@ } ], "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", @@ -107967,13 +116036,84 @@ "name": "displaytext", "type": "string" }, + {} + ] + }, + { + "description": "Register a new userdata.", + "isasync": false, + "name": "registerUserData", + "params": [ + { + "description": "Name of the userdata", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "an optional project for the userdata", + "length": 255, + "name": "projectid", + "related": "activateProject", + "required": false, + "type": "uuid" + }, + { + "description": "Userdata content", + "length": 1048576, + "name": "userdata", + "required": true, + "type": "string" + }, + { + "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "comma separated list of variables declared in userdata content", + "length": 255, + "name": "params", + "required": false, + "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} - ] + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.18" }, { "description": "Adds a Region", @@ -107981,9 +116121,9 @@ "name": "addRegion", "params": [ { - "description": "Name of the region", + "description": "Region service endpoint", "length": 255, - "name": "name", + "name": "endpoint", "required": true, "type": "string" }, @@ -107995,52 +116135,130 @@ "type": "integer" }, { - "description": "Region service endpoint", + "description": "Name of the region", "length": 255, - "name": "endpoint", + "name": "name", "required": true, "type": "string" } ], "related": "", "response": [ + { + "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 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 ID of the region", + "name": "id", + "type": "integer" }, { "description": "true if GSLB service is enabled in the region, false otherwise", "name": "gslbserviceenabled", "type": "boolean" }, + {}, { - "description": "the name of the region", - "name": "name", + "description": "the end point of the region", + "name": "endpoint", "type": "string" }, { - "description": "the ID of the region", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Lists Tungsten-Fabric tags", + "isasync": false, + "name": "listTungstenFabricTagType", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" + "description": "the uuid of Tungsten-Fabric tag type", + "length": 255, + "name": "tagtypeuuid", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric tag type name", + "name": "name", + "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -108072,6 +116290,13 @@ } ], "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", @@ -108082,18 +116307,11 @@ "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" - }, - {} + } ] }, { @@ -108101,14 +116319,6 @@ "isasync": false, "name": "updateRolePermission", "params": [ - { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", - "length": 255, - "name": "ruleorder", - "related": "", - "required": false, - "type": "list" - }, { "description": "Rule permission, can be: allow or deny", "length": 255, @@ -108125,6 +116335,14 @@ "required": true, "type": "uuid" }, + { + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "length": 255, + "name": "ruleorder", + "related": "", + "required": false, + "type": "list" + }, { "description": "Role permission rule id", "length": 255, @@ -108136,27 +116354,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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "4.9.0" @@ -108167,16 +116385,9 @@ "name": "listSSHKeyPairs", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "A public key fingerprint to look for", + "description": "A key pair name to look for", "length": 255, - "name": "fingerprint", + "name": "name", "required": false, "type": "string" }, @@ -108188,26 +116399,28 @@ "type": "integer" }, { - "description": "A key pair name to look for", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "name", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "activateProject", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the ssh keypair", "length": 255, - "name": "account", + "name": "id", + "related": "listSSHKeyPairs", "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.", @@ -108216,14 +116429,6 @@ "required": false, "type": "boolean" }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -108232,12 +116437,11 @@ "type": "string" }, { - "description": "the ID of the ssh keypair", + "description": "", "length": 255, - "name": "id", - "related": "listSSHKeyPairs", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -108245,6 +116449,20 @@ "name": "listall", "required": false, "type": "boolean" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "A public key fingerprint to look for", + "length": 255, + "name": "fingerprint", + "required": false, + "type": "string" } ], "related": "", @@ -108255,30 +116473,34 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the keypair", + "name": "name", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Fingerprint of the public key", + "name": "fingerprint", + "type": "string" }, {}, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, { @@ -108287,13 +116509,19 @@ "type": "boolean" }, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, + {}, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "the project name of the keypair owner", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" } ] @@ -108310,13 +116538,6 @@ "required": false, "type": "list" }, - { - "description": "list account by account name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "List by keyword", "length": 255, @@ -108325,40 +116546,39 @@ "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 account by account name", "length": 255, - "name": "listall", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list accounts by cleanuprequired attribute (values are true or false)", + "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", "length": 255, - "name": "iscleanuprequired", + "name": "accounttype", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list account by account ID", + "description": "list accounts by state. Valid states are enabled, disabled, and locked.", "length": 255, - "name": "id", - "related": "enableAccount,listAccounts,listAccounts", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list accounts by cleanuprequired attribute (values are true or false)", "length": 255, - "name": "page", + "name": "iscleanuprequired", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -108368,25 +116588,26 @@ "type": "boolean" }, { - "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", + "description": "list account by account ID", "length": 255, - "name": "accounttype", + "name": "id", + "related": "enableAccount,listAccounts,listAccounts", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "flag to display the resource icon for accounts", + "description": "", "length": 255, - "name": "showicon", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list accounts by state. Valid states are enabled, disabled, and locked.", + "description": "flag to display the resource icon for accounts", "length": 255, - "name": "state", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list only resources belonging to the domain specified", @@ -108395,239 +116616,202 @@ "related": "listDomains", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "enableAccount,listAccounts", "response": [ { - "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": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the name of the account", - "name": "name", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, + {}, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "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 templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "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", - "type": "integer" - }, - {}, - { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", "type": "boolean" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "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", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "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 total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "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": "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 name of the role", - "name": "rolename", + "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", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, { @@ -108635,8 +116819,8 @@ "name": "user", "response": [ { - "description": "the user lastname", - "name": "lastname", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -108645,23 +116829,13 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user name", + "name": "username", "type": "string" }, { @@ -108670,34 +116844,34 @@ "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the ID of the role", + "name": "roleid", "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": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { "description": "the account type of the user", @@ -108705,13 +116879,18 @@ "type": "integer" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user state", + "name": "state", "type": "string" }, { @@ -108720,13 +116899,8 @@ "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { @@ -108735,53 +116909,107 @@ "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { "description": "the user ID", "name": "id", "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" } ], "type": "list" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "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 available for this account to acquire", - "name": "ipavailable", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "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 memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, - {}, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { "description": "the id of the account", @@ -108789,34 +117017,44 @@ "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the account", + "name": "name", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" } ] }, @@ -108837,19 +117075,19 @@ "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 overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { "description": "true if this pool is suitable to migrate a volume, false otherwise", @@ -108857,13 +117095,8 @@ "type": "boolean" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { @@ -108872,111 +117105,116 @@ "type": "storagepoolstatus" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "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", "type": "long" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "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 date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { "description": "the name of the cluster for the storage pool", "name": "clustername", "type": "string" }, - {}, { - "description": "Storage provider for this pool", - "name": "provider", + "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 ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, + { + "description": "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "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 scope of the storage pool", - "name": "scope", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" - }, - { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" } ] }, @@ -108996,181 +117234,19 @@ ], "related": "", "response": [ - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "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": "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 name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - } - ], - "type": "set" - }, { "description": "the Zone name for the router", "name": "zonename", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { @@ -109179,73 +117255,105 @@ "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the template ID for the router", + "name": "templateid", "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 first DNS for the router", - "name": "dns1", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the address", - "name": "project", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { @@ -109253,92 +117361,72 @@ "name": "linklocalnetworkid", "type": "string" }, - { - "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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the hostname for the router", + "name": "hostname", "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 public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, { "description": "the state of the router", "name": "state", "type": "state" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the domain ID associated with the router", + "name": "domainid", "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 public MAC address for the router", - "name": "publicmacaddress", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" }, { "description": "the guest MAC address for the router", @@ -109346,95 +117434,255 @@ "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, - {}, - {}, { - "description": "role of the domain router", - "name": "role", + "description": "the template name for the router", + "name": "templatename", "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "VPC the router 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 router", - "name": "account", + "description": "the id of the router", + "name": "id", "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 Pod ID for the router", - "name": "podid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "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": "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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the 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 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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" } ] @@ -109445,12 +117693,12 @@ "name": "updateSnapshotPolicy", "params": [ { - "description": "the ID of the snapshot policy", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "id", - "related": "updateSnapshotPolicy", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { "description": "an optional field, whether to the display the snapshot policy to the end user or not.", @@ -109461,19 +117709,35 @@ "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 ID of the snapshot policy", "length": 255, - "name": "customid", + "name": "id", + "related": "updateSnapshotPolicy", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, + { + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { @@ -109481,11 +117745,31 @@ "name": "id", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + { + "description": "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": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, {}, { "description": "the list of resource tags associated", @@ -109496,24 +117780,29 @@ "name": "value", "type": "string" }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -109522,63 +117811,22 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" - }, - { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" - }, - {}, - { - "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" } ] }, @@ -109598,40 +117846,36 @@ ], "related": "", "response": [ - {}, { "description": "the result code for the job", "name": "jobresultcode", "type": "integer" }, + {}, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the account that executed the async command", + "name": "accountid", "type": "string" }, + {}, { - "description": " the created date of the job", - "name": "created", + "description": " the completed date of the job", + "name": "completed", "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the async command executed", - "name": "cmd", + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "the user that executed the async command", + "name": "userid", + "type": "string" }, { - "description": "the account that executed the async command", - "name": "accountid", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { @@ -109640,9 +117884,14 @@ "type": "integer" }, { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, { "description": "the current job status-should be 0 for PENDING", @@ -109650,24 +117899,23 @@ "type": "integer" }, { - "description": " the completed date of the job", - "name": "completed", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the result type", - "name": "jobresulttype", + "description": "the async command executed", + "name": "cmd", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": " the created date of the job", + "name": "created", + "type": "date" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the result type", + "name": "jobresulttype", "type": "string" } ] @@ -109678,9 +117926,9 @@ "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" }, @@ -109692,66 +117940,71 @@ "type": "integer" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "URL of the netscaler controlcenter appliance.", "length": 255, - "name": "username", + "name": "ipaddress", "required": true, "type": "string" }, { - "description": "URL of the netscaler controlcenter appliance.", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "ipaddress", + "name": "password", "required": true, "type": "string" } ], "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", "response": [ + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + {}, { "description": "device state", "name": "lbdevicestate", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "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": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "device name", - "name": "lbdevicename", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", - "type": "string" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "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" }, { @@ -109760,8 +118013,8 @@ "type": "boolean" }, { - "description": "name of the provider", - "name": "provider", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, {}, @@ -109771,13 +118024,13 @@ "type": "boolean" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -109785,15 +118038,10 @@ "name": "lbdevicededicated", "type": "boolean" }, - { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + { + "description": "device name", + "name": "lbdevicename", + "type": "string" } ] }, @@ -109803,79 +118051,79 @@ "name": "listImageStores", "params": [ { - "description": "the image store protocol", + "description": "read-only status of the image store", "length": 255, - "name": "protocol", + "name": "readonly", + "related": "listImageStores", "required": false, - "type": "string" + "since": "4.15.0", + "type": "boolean" }, { - "description": "", + "description": "the image store provider", "length": 255, - "name": "page", + "name": "provider", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the image store protocol", "length": 255, - "name": "pagesize", + "name": "protocol", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the image store provider", + "description": "the ID of the storage pool", "length": 255, - "name": "provider", + "name": "id", + "related": "listImageStores", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the Zone ID for the image store", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the image store", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "read-only status of the image store", + "description": "", "length": 255, - "name": "readonly", - "related": "listImageStores", + "name": "page", "required": false, - "since": "4.15.0", - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the storage pool", + "description": "", "length": 255, - "name": "id", - "related": "listImageStores", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the Zone ID for the image store", + "description": "the name of the image store", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "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 protocol of the image store", @@ -109883,29 +118131,33 @@ "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 Zone ID of the image store", - "name": "zoneid", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, - {}, { "description": "the 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 Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the image store", + "name": "name", "type": "string" }, { @@ -109914,36 +118166,32 @@ "type": "scopetype" }, { - "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 ID of the image store", "name": "id", "type": "string" }, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - } + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + {}, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + {} ], "since": "4.2.0" }, @@ -109962,46 +118210,54 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Adds metric counter", + "description": "Adds metric counter for VM auto scaling", "isasync": true, "name": "createCounter", "params": [ { - "description": "Value of the counter e.g. oid in case of snmp.", + "description": "Source of the counter.", "length": 255, - "name": "value", + "name": "source", "required": true, "type": "string" }, { - "description": "Source of the counter.", + "description": "Network provider of the counter.", "length": 255, - "name": "source", + "name": "provider", + "required": true, + "since": "4.18.0", + "type": "string" + }, + { + "description": "Value of the counter e.g. oid in case of snmp.", + "length": 255, + "name": "value", "required": true, "type": "string" }, @@ -110015,30 +118271,29 @@ ], "related": "", "response": [ - {}, { - "description": "Source of the counter.", - "name": "source", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, { - "description": "Name of the counter.", - "name": "name", + "description": "the id of the Counter", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Provider of the counter.", + "name": "provider", "type": "string" }, { - "description": "the id of the Counter", - "name": "id", + "description": "Source of the counter.", + "name": "source", "type": "string" }, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -110047,10 +118302,16 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "zone id of counter", "name": "zoneid", "type": "string" + }, + { + "description": "Name of the counter.", + "name": "name", + "type": "string" } ] }, @@ -110061,23 +118322,23 @@ "params": [], "related": "", "response": [ + {}, + {}, { "description": "Event Type", "name": "name", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -110097,13 +118358,19 @@ "related": "", "response": [ { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, + {}, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -110111,20 +118378,15 @@ "name": "enabled", "type": "boolean" }, - { - "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 operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" }, { "description": "the ID of the host", @@ -110132,36 +118394,35 @@ "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { "description": "the out-of-band management interface address", "name": "address", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the out-of-band management driver for the host", "name": "driver", "type": "string" + }, + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" } ], "since": "4.9.0" @@ -110172,24 +118433,24 @@ "name": "addCluster", "params": [ { - "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", "length": 255, - "name": "guestvswitchname", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "Ovm3 native pooling enabled for 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": "ovm3pool", + "name": "publicvswitchtype", "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": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "guestvswitchtype", - "required": false, + "name": "clustertype", + "required": true, "type": "string" }, { @@ -110200,20 +118461,11 @@ "type": "string" }, { - "description": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "the Zone ID for the cluster", + "description": "the URL", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "url", + "required": false, + "type": "string" }, { "description": "the username for the cluster", @@ -110223,51 +118475,52 @@ "type": "string" }, { - "description": "the ipaddress of the VSM associated with this cluster", + "description": "Ovm3 native pooling enabled for cluster", "length": 255, - "name": "vsmipaddress", + "name": "ovm3pool", "required": false, "type": "string" }, { - "description": "the password for the host", + "description": "the Pod ID for the host", "length": 255, - "name": "password", - "required": false, - "type": "string" + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the password for the VSM associated with this cluster", + "description": "Ovm3 vip to use for pool (and cluster)", "length": 255, - "name": "vsmpassword", + "name": "ovm3vip", "required": false, "type": "string" }, { - "description": "Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", + "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "publicvswitchtype", + "name": "publicvswitchname", "required": false, "type": "string" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "the password for the VSM associated with this cluster", "length": 255, - "name": "clustertype", - "required": true, + "name": "vsmpassword", + "required": false, "type": "string" }, { - "description": "Ovm3 native OCFS2 clustering enabled for cluster", + "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "ovm3cluster", + "name": "guestvswitchname", "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" }, @@ -110279,30 +118532,38 @@ "type": "string" }, { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", + "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": "hypervisor", - "required": true, + "name": "guestvswitchtype", + "required": false, "type": "string" }, { - "description": "Ovm3 vip to use for pool (and cluster)", + "description": "the password for the host", "length": 255, - "name": "ovm3vip", + "name": "password", "required": false, "type": "string" }, { - "description": "the URL", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "url", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the Zone ID for the cluster", "length": 255, - "name": "allocationstate", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Ovm3 native OCFS2 clustering enabled for cluster", + "length": 255, + "name": "ovm3cluster", "required": false, "type": "string" } @@ -110314,19 +118575,33 @@ "name": "zonename", "type": "string" }, - {}, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the Cluster name", - "name": "clustername", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -110335,8 +118610,8 @@ "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { @@ -110344,24 +118619,14 @@ "name": "capacityused", "type": "long" }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, { "description": "the Pod ID", "name": "podid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { @@ -110370,36 +118635,31 @@ "type": "long" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Zone name", + "name": "zonename", + "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Zone ID", + "name": "zoneid", "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" } ], "type": "list" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", - "type": "string" - }, - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "the cluster ID", - "name": "id", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { @@ -110407,19 +118667,10 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - }, - { - "description": "the type of the cluster", - "name": "clustertype", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { @@ -110433,36 +118684,46 @@ "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "the cluster ID", + "name": "id", "type": "string" }, + {}, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the cluster name", + "name": "name", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, - {} + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + } ] }, { @@ -110474,17 +118735,12 @@ "description": "Id of the Traffic Monitor Host.", "length": 255, "name": "id", - "related": "addBaremetalHost,reconnectHost", + "related": "reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -110495,13 +118751,18 @@ "name": "success", "type": "boolean" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {} + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -110510,18 +118771,18 @@ "name": "removeNicFromVirtualMachine", "params": [ { - "description": "NIC ID", + "description": "Virtual Machine ID", "length": 255, - "name": "nicid", - "related": "", + "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", "required": true, "type": "uuid" }, { - "description": "Virtual Machine ID", + "description": "NIC ID", "length": 255, - "name": "virtualmachineid", - "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "name": "nicid", + "related": "", "required": true, "type": "uuid" } @@ -110529,64 +118790,54 @@ "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "response": [ { - "description": "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 the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, + {}, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "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": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, - {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { @@ -110595,58 +118846,68 @@ "type": "integer" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "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 group name of the virtual machine", - "name": "group", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "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": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the 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": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -110655,89 +118916,314 @@ "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, + {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "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" + } + ], + "type": "set" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Guest vm Boot Mode", + "name": "bootmode", "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", + "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": "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "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": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { "description": "the date when this virtual machine was created", @@ -110745,101 +119231,172 @@ "type": "date" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, - {}, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the 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 project name of the group", - "name": "project", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the 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 protocol of the security group rule", - "name": "protocol", + "description": "id of the resource", + "name": "resourceid", "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the 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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -110848,135 +119405,93 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the 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 domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "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": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -110984,23 +119499,28 @@ "name": "startport", "type": "integer" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -111008,59 +119528,44 @@ "name": "value", "type": "string" }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the id of the security group rule", "name": "ruleid", @@ -111069,38 +119574,38 @@ ], "type": "set" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, { "description": "the number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", "type": "integer" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", + "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" } ], "type": "set" }, { - "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 name of the virtual machine", - "name": "name", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { "description": "the total number of network traffic bytes sent", @@ -111108,361 +119613,177 @@ "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 the virtual machine", + "name": "id", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, - {}, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "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 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 target memory in VM (KiB)", "name": "memorytargetkbs", "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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 project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - } - ], - "type": "set" + "description": "OS name of the vm", + "name": "osdisplayname", + "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 name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "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": "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": "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the 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 if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the domain name of the affinity group", + "name": "domain", "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": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the nic", + "description": "the ID of the affinity group", "name": "id", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ], "type": "set" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { "description": "public IP address id associated with vm via Static nat rule", @@ -111470,24 +119791,9 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "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" } ] }, @@ -111508,38 +119814,18 @@ "related": "", "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the id of the project", - "name": "id", - "type": "string" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "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 name of the project", - "name": "name", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { @@ -111548,89 +119834,69 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the total 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", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "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 total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { @@ -111638,48 +119904,48 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag 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 key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -111691,48 +119957,83 @@ "type": "list" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the domain name where the project belongs to", + "name": "domain", "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 primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", + "description": "the state of the project", + "name": "state", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the id of the project", + "name": "id", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the 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", + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "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) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { @@ -111740,65 +120041,70 @@ "name": "owner", "type": "list" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, { "description": "the total volume being used by this project", "name": "volumetotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, {}, { - "description": "the total 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 available to be created for this project", - "name": "networkavailable", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" } ], @@ -111819,28 +120125,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", + "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" - } + }, + {}, + {} ] }, { @@ -111849,25 +120155,18 @@ "name": "listDedicatedHosts", "params": [ { - "description": "the name of the account associated with the host. Must be used with domainId.", + "description": "the ID of the domain associated with the host", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "addBaremetalHost,reconnectHost", - "required": false, - "type": "uuid" - }, - { - "description": "list dedicated hosts by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "", + "related": "reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, @@ -111886,12 +120185,11 @@ "type": "integer" }, { - "description": "the ID of the domain associated with the host", + "description": "the name of the account associated with the host. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "List by keyword", @@ -111899,11 +120197,28 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "list dedicated hosts by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" } ], "related": "", "response": [ - {}, + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + }, + { + "description": "the Account ID of the host", + "name": "accountid", + "type": "string" + }, { "description": "the domain ID of the host", "name": "domainid", @@ -111914,36 +120229,27 @@ "name": "hostname", "type": "string" }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, { "description": "the Dedication Affinity Group ID of the host", "name": "affinitygroupid", "type": "string" }, + {}, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the ID of the host", + "name": "hostid", "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" } ] }, @@ -111953,22 +120259,59 @@ "name": "getUploadParamsForIso", "params": [ { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "length": 255, + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the zone the volume/template is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the display text of the ISO. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": true, + "type": "string" + }, + { + "description": "Upload volume/template for the project", "length": 255, - "name": "ostypeid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "the name of the ISO", + "description": "the name of the volume/template", "length": 255, "name": "name", "required": true, "type": "string" }, { - "description": "the name of the volume/template", + "description": "true if you want this ISO to be featured", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" + }, + { + "description": "the name of the ISO", "length": 255, "name": "name", "required": true, @@ -111982,19 +120325,12 @@ "type": "boolean" }, { - "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" }, - { - "description": "the checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, - "type": "string" - }, { "description": "the ID of the zone you wish to register the ISO to.", "length": 255, @@ -112003,22 +120339,6 @@ "required": true, "type": "uuid" }, - { - "description": "the ID of the zone the volume/template is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "Upload volume/template for the project", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, { "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", "length": 255, @@ -112035,46 +120355,39 @@ "type": "uuid" }, { - "description": "true if you want this ISO to be featured", + "description": "the checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", 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": "isfeatured", + "name": "checksum", "required": false, - "type": "boolean" - }, - { - "description": "the display text of the ISO. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": true, "type": "string" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "ispublic", + "name": "bootable", "required": false, "type": "boolean" - }, - { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "related": "", "response": [ - { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" - }, { "description": "signature to be sent in the POST request.", "name": "signature", "type": "string" }, + { + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -112085,22 +120398,15 @@ "name": "expires", "type": "string" }, + { + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" + }, { "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": "encrypted data to be sent in the POST request.", - "name": "metadata", - "type": "string" } ], "since": "4.13" @@ -112134,6 +120440,7 @@ "type": "string" }, {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -112143,8 +120450,7 @@ "description": "Storage URL to download retrieve diagnostics data files", "name": "url", "type": "string" - }, - {} + } ], "since": "4.14.0.0" }, @@ -112160,6 +120466,14 @@ "related": "", "required": true, "type": "uuid" + }, + { + "description": "true if all VMs have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.18.0", + "type": "boolean" } ], "response": [ @@ -112173,18 +120487,18 @@ "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" - } + {} ] }, { @@ -112192,13 +120506,6 @@ "isasync": false, "name": "listPaloAltoFirewalls", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -112214,6 +120521,13 @@ "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -112233,96 +120547,96 @@ "related": "addPaloAltoFirewall", "response": [ { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "device state", + "name": "fwdevicestate", + "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "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": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" } ] }, @@ -112331,6 +120645,14 @@ "isasync": true, "name": "updateLoadBalancerRule", "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 protocol for the LB", "length": 255, @@ -112339,17 +120661,16 @@ "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "fordisplay", + "name": "algorithm", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "description": "the name of the load balancer rule", + "length": 255, + "name": "name", "required": false, "type": "string" }, @@ -112362,53 +120683,51 @@ "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "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" }, { - "description": "the name of the load balancer rule", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "name", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" } ], "related": "listLoadBalancerRules", "response": [ { - "description": "the public ip address", - "name": "publicip", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { @@ -112417,18 +120736,28 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { @@ -112436,18 +120765,23 @@ "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", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -112456,8 +120790,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -112466,87 +120800,66 @@ "type": "string" }, { - "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": "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": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the state of the rule", "name": "state", "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" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -112554,6 +120867,7 @@ "name": "zonename", "type": "string" }, + {}, {} ] }, @@ -112569,13 +120883,6 @@ "required": false, "type": "date" }, - { - "description": "delete by alert type", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, { "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, @@ -112590,152 +120897,79 @@ "related": "", "required": false, "type": "list" - } - ], - "response": [ - {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" }, { - "description": "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": "Enables an account", - "isasync": false, - "name": "enableAccount", - "params": [ - { - "description": "Enables specified account.", + "description": "delete by alert type", "length": 255, - "name": "account", + "name": "type", "required": false, "type": "string" - }, - { - "description": "Account id", - "length": 255, - "name": "id", - "related": "enableAccount,listAccounts", - "required": false, - "type": "uuid" - }, - { - "description": "Enables specified account in this domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" } ], - "related": "listAccounts", "response": [ { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Enables an account", + "isasync": false, + "name": "enableAccount", + "params": [ + { + "description": "Account id", + "length": 255, + "name": "id", + "related": "enableAccount,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "Enables specified account.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "Enables specified account in this domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "listAccounts", + "response": [ + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -112744,107 +120978,107 @@ "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the 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 name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "the 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 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 secret key of the user", - "name": "secretkey", + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -112852,194 +121086,289 @@ "name": "iscallerchilddomain", "type": "boolean" }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, { "description": "the user name", "name": "username", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the domain ID of the user", + "name": "domainid", "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 domain ID of the user", - "name": "domainid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "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 api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the role", + "name": "roleid", + "type": "string" } ], "type": "list" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { "description": "account type (admin, domain-admin, user)", "name": "accounttype", "type": "integer" }, + {}, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" }, - {}, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", "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": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, { "description": "the id of the account", "name": "id", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, { "description": "the total number of virtual machines that can be deployed by this account", "name": "vmlimit", "type": "string" }, { - "description": "the 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": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + {}, + { + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { @@ -113048,24 +121377,19 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" } ] }, @@ -113075,28 +121399,26 @@ "name": "createAutoScaleVmProfile", "params": [ { - "description": "availability zone for the auto deployed virtual machine", + "description": "the time allowed for existing connections to get closed before a vm is expunged", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "expungevmgraceperiod", + "required": false, + "type": "integer" }, { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "an optional field, whether to the display the profile to the end user or not", "length": 255, - "name": "autoscaleuserid", - "related": "getUser", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "the template of the auto deployed virtual machine", + "description": "account that will own the autoscale VM profile", "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { "description": "the service offering of the auto deployed virtual machine", @@ -113107,63 +121429,101 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the profile to the end user or not", + "description": "an optional project for the autoscale VM profile", "length": 255, - "name": "fordisplay", + "name": "projectid", + "related": "", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", "length": 255, - "name": "destroyvmgraceperiod", + "name": "counterparam", "required": false, - "type": "integer" + "type": "map" }, { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "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": "counterparam", + "name": "otherdeployparams", "required": false, "type": "map" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine", + "description": "the ID of the user used to launch and destroy the VMs", "length": 255, - "name": "otherdeployparams", + "name": "autoscaleuserid", + "related": "getUser", + "required": false, + "type": "uuid" + }, + { + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", "required": false, + "since": "4.18.0", "type": "string" + }, + { + "description": "the template of the auto deployed virtual machine", + "length": 255, + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" + }, + { + "description": "domain ID of the account owning a autoscale VM profile", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "availability zone for the auto deployed virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], "related": "", "response": [ {}, { - "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": "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" + }, + { + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the domain name of the vm profile", @@ -113171,27 +121531,15 @@ "type": "string" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "destroyvmgraceperiod", - "type": "integer" - }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, - {}, { "description": "the project id vm profile", "name": "projectid", @@ -113203,8 +121551,19 @@ "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "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 availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, { @@ -113212,6 +121571,7 @@ "name": "templateid", "type": "string" }, + {}, { "description": "the account owning the instance group", "name": "account", @@ -113225,19 +121585,20 @@ "name": "listLBStickinessPolicies", "params": [ { - "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": "the ID of the load balancer rule", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "lbruleid", - "related": "", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { "description": "", @@ -113247,124 +121608,123 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the load balancer stickiness policy", + "description": "the ID of the load balancer rule", "length": 255, - "name": "id", - "related": "listLBStickinessPolicies", + "name": "lbruleid", + "related": "", "required": false, "type": "uuid" } ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the 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 LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the 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 list of stickinesspolicies", "name": "stickinesspolicy", "response": [ + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, { "description": "is policy for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, - { - "description": "the params of the policy", - "name": "params", - "type": "map" - }, { "description": "the LB Stickiness policy ID", "name": "id", "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the method name of the Stickiness policy", + "name": "methodname", "type": "string" }, { - "description": "the state of the policy", - "name": "state", - "type": "string" + "description": "the params of the policy", + "name": "params", + "type": "map" } ], "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + {}, + { + "description": "the domain of the Stickiness policy", + "name": "domain", + "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 state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + {}, + { + "description": "the domain ID of the Stickiness policy", + "name": "domainid", + "type": "string" } ], "since": "3.0.0" @@ -113374,6 +121734,14 @@ "isasync": false, "name": "addUcsManager", "params": [ + { + "description": "the Zone id for the ucs manager", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { "description": "the name of UCS url", "length": 255, @@ -113382,19 +121750,18 @@ "type": "string" }, { - "description": "the username of UCS", + "description": "the name of UCS manager", "length": 255, - "name": "username", - "required": true, + "name": "name", + "required": false, "type": "string" }, { - "description": "the Zone id for the ucs manager", + "description": "the username of UCS", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "username", "required": true, - "type": "uuid" + "type": "string" }, { "description": "the password of UCS", @@ -113402,48 +121769,41 @@ "name": "password", "required": true, "type": "string" - }, - { - "description": "the name of UCS manager", - "length": 255, - "name": "name", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "the zone ID of ucs manager", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of ucs manager", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the ucs manager", - "name": "id", + "description": "the url of ucs manager", + "name": "url", "type": "string" }, {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the url of ucs manager", - "name": "url", + "description": "the zone ID of ucs manager", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of ucs manager", + "name": "name", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "the ID of the ucs manager", + "name": "id", + "type": "string" } ] }, @@ -113452,6 +121812,13 @@ "isasync": true, "name": "deleteNetwork", "params": [ + { + "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, { "description": "the ID of the network", "length": 255, @@ -113459,37 +121826,30 @@ "related": "createNetwork,updateNetwork,listNetworks", "required": true, "type": "uuid" - }, - { - "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" } ], "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, @@ -113502,7 +121862,7 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addBaremetalHost,reconnectHost", + "related": "reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } @@ -113510,18 +121870,18 @@ "related": "addBaremetalHost", "response": [ { - "description": "the Pod name of the host", - "name": "podname", - "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 management server ID of the host", - "name": "managementserverid", + "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 amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { @@ -113529,156 +121889,116 @@ "name": "disconnected", "type": "date" }, - {}, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, + {}, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "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 amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the host version", + "name": "version", "type": "string" }, + {}, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { @@ -113687,94 +122007,99 @@ "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 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 date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the 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 local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "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 Pod ID of the host", - "name": "podid", + "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": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "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": "events available for the host", + "name": "events", + "type": "string" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { "description": "GPU cards present in the host", @@ -113785,8 +122110,13 @@ "name": "vgpu", "response": [ { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { @@ -113794,34 +122124,29 @@ "name": "vgputype", "type": "string" }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, { "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", "name": "remainingcapacity", "type": "long" }, { - "description": "Maximum 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" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" } ], @@ -113836,39 +122161,79 @@ "type": "list" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "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", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "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 HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the Pod name of the host", + "name": "podname", "type": "string" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -113888,51 +122253,56 @@ ], "related": "", "response": [ + {}, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" + }, + { + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, - {}, { "description": "Maximum size of the cluster", "name": "maxsize", "type": "long" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" }, { "description": "the project id of the Kubernetes cluster", @@ -113940,63 +122310,68 @@ "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "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 name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "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", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "type": "long" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the description of the Kubernetes cluster", + "name": "description", "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 project name of the Kubernetes cluster", - "name": "project", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { @@ -114005,29 +122380,29 @@ "type": "date" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "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 memory the Kubernetes cluster", + "name": "memory", + "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": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { "description": "Whether autoscaling is enabled for the cluster", @@ -114035,40 +122410,30 @@ "type": "boolean" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", "type": "long" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", - "type": "string" - }, - { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the ID of the domain in which the Kubernetes cluster exists", "name": "domainid", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" - }, - { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, - {}, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" } ] }, @@ -114095,28 +122460,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": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ], "since": "3.0.0" }, @@ -114126,10 +122491,17 @@ "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": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", "required": false, "type": "uuid" }, @@ -114141,10 +122513,10 @@ "type": "integer" }, { - "description": "the Physical Network ID", + "description": "netscaler load balancer device ID", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", "required": false, "type": "uuid" }, @@ -114154,55 +122526,23 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "addNetscalerLoadBalancer", "response": [ { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" - }, - { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" - }, - { - "description": "the 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": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { @@ -114216,40 +122556,65 @@ "type": "list" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "device name", - "name": "lbdevicename", + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + }, + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the private interface of the load balancer", "name": "privateinterface", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "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": "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": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "lbdevicename", "type": "string" } ] @@ -114260,10 +122625,10 @@ "name": "createInstanceGroup", "params": [ { - "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" }, @@ -114275,19 +122640,19 @@ "type": "string" }, { - "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", + "description": "the domain ID of account owning the instance group", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The project of the instance group", + "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", @@ -114298,45 +122663,34 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the domain name of the instance group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the account owning the instance group", + "name": "account", "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" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "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" }, { @@ -114345,10 +122699,21 @@ "type": "string" }, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" - } + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain name of the instance group", + "name": "domain", + "type": "string" + }, + { + "description": "the project ID of the instance group", + "name": "projectid", + "type": "string" + }, + {} ] }, { @@ -114372,28 +122737,22 @@ "name": "id", "type": "string" }, - {}, + { + "description": "the list of projects the template is available for", + "name": "projectids", + "type": "list" + }, {}, { "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 current status of the latest async job acting 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", @@ -114403,6 +122762,12 @@ "description": "the list of accounts the template is available for", "name": "account", "type": "list" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -114411,6 +122776,13 @@ "isasync": true, "name": "addNetscalerLoadBalancer", "params": [ + { + "description": "Credentials to reach netscaler load balancer device", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, { "description": "true if NetScaler device being added is for providing GSLB service", "length": 255, @@ -114418,6 +122790,13 @@ "required": false, "type": "boolean" }, + { + "description": "public IP of the site", + "length": 255, + "name": "gslbproviderpublicip", + "required": false, + "type": "string" + }, { "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", "length": 255, @@ -114439,20 +122818,6 @@ "required": false, "type": "boolean" }, - { - "description": "Credentials to reach netscaler load balancer device", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, - { - "description": "public IP of the site", - "length": 255, - "name": "gslbproviderpublicip", - "required": false, - "type": "string" - }, { "description": "the Physical Network ID", "length": 255, @@ -114462,67 +122827,72 @@ "type": "uuid" }, { - "description": "private IP of the site", + "description": "Credentials to reach netscaler load balancer device", "length": 255, - "name": "gslbproviderprivateip", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "Credentials to reach netscaler load balancer device", + "description": "private IP of the site", "length": 255, - "name": "username", - "required": true, + "name": "gslbproviderprivateip", + "required": false, "type": "string" } ], "related": "", "response": [ { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", "type": "boolean" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", + "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": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "device name", + "name": "lbdevicename", "type": "string" }, + {}, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "device capacity", "name": "lbdevicecapacity", "type": "long" }, { - "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": "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.", @@ -114530,39 +122900,34 @@ "type": "list" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, - {}, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "device name", - "name": "lbdevicename", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" } ] @@ -114573,148 +122938,118 @@ "name": "createLoadBalancer", "params": [ { - "description": "the network id of the source ip address", + "description": "the source port the network traffic will be load balanced from", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "sourceport", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": true, + "description": "the description of the load balancer", + "length": 4096, + "name": "description", + "required": false, "type": "string" }, { - "description": "name of the load balancer", + "description": "The guest network the load balancer will be created for", "length": 255, - "name": "name", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "instanceport", - "required": true, - "type": "integer" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the source IP address the network traffic will be load balanced from", + "description": "the network id of the source ip address", "length": 255, - "name": "sourceipaddress", - "required": false, - "type": "string" + "name": "sourceipaddressnetworkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": true, + "type": "uuid" }, { - "description": "the source port the network traffic will be load balanced from", + "description": "the load balancer scheme. Supported value in this release is Internal", "length": 255, - "name": "sourceport", + "name": "scheme", "required": true, - "type": "integer" + "type": "string" }, { - "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": "the load balancer scheme. Supported value in this release is Internal", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "scheme", + "name": "algorithm", "required": true, "type": "string" }, { - "description": "the description of the load balancer", - "length": 4096, - "name": "description", - "required": false, + "description": "name of the load balancer", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the source IP address the network traffic will be load balanced from", "length": 255, - "name": "fordisplay", + "name": "sourceipaddress", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the account of the Load Balancer", + "name": "account", "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the 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", + "description": "the state of the instance", + "name": "state", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the name of the instance", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the instance ID", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" } ], "type": "list" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the domain of the Load Balancer", "name": "domain", @@ -114724,11 +123059,6 @@ "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", @@ -114738,29 +123068,24 @@ "description": "instance port of the load balancer rule", "name": "instanceport", "type": "integer" + }, + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" } ], "type": "list" }, { - "description": "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the project id of the Load Balancer", @@ -114768,61 +123093,81 @@ "type": "string" }, { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" - }, - {}, - { - "description": "the description of the Load Balancer", - "name": "description", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "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": "tag key name", + "name": "key", "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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" } ], "type": "list" }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, + {}, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" }, {}, @@ -114830,6 +123175,26 @@ "description": "the domain ID of the Load Balancer", "name": "domainid", "type": "string" + }, + { + "description": "the description of the Load Balancer", + "name": "description", + "type": "string" + }, + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" + }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" } ], "since": "4.2.0" @@ -114839,6 +123204,14 @@ "isasync": false, "name": "removeNetworkPermissions", "params": [ + { + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "projectids", + "related": "", + "required": false, + "type": "list" + }, { "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, @@ -114847,10 +123220,10 @@ "type": "list" }, { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "projectids", - "related": "", + "name": "accountids", + "related": "listAccounts", "required": false, "type": "list" }, @@ -114861,41 +123234,80 @@ "related": "createNetwork,updateNetwork,listNetworks", "required": true, "type": "uuid" - }, - { - "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "accountids", - "related": "listAccounts", - "required": false, - "type": "list" } ], "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "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.0" + }, + { + "description": "config Tungsten-Fabric service", + "isasync": false, + "name": "configTungstenFabricService", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of physical network", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job 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" + ] }, { "description": "list baremetal pxe server", @@ -114903,49 +123315,44 @@ "name": "listBaremetalPxeServers", "params": [ { - "description": "List by keyword", + "description": "Pxe server device ID", "length": 255, - "name": "keyword", + "name": "id", "required": false, - "type": "string" + "type": "long" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "name": "page", + "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": "", + "description": "the Physical Network ID", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - { - "description": "url", - "name": "url", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -114956,22 +123363,27 @@ "name": "provider", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "device id of ", "name": "id", "type": "string" }, - {}, { "description": "the physical network to which this external dhcp device belongs to", "name": "physicalnetworkid", "type": "string" }, {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "url", + "name": "url", + "type": "string" } ] }, @@ -114988,12 +123400,11 @@ "type": "string" }, { - "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": "supports only PaloAltoFirewall", @@ -115003,11 +123414,12 @@ "type": "string" }, { - "description": "Credentials to reach Palo Alto firewall device", + "description": "the Physical Network ID", "length": 255, - "name": "password", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Credentials to reach Palo Alto firewall device", @@ -115020,23 +123432,33 @@ "related": "", "response": [ { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the public security zone of the external firewall", + "name": "publiczone", + "type": "string" + }, + { + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the private interface of the external firewall", "name": "privateinterface", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -115045,45 +123467,40 @@ "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "the public interface of the external firewall", + "name": "publicinterface", + "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, {}, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { @@ -115092,8 +123509,8 @@ "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -115102,14 +123519,9 @@ "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", - "type": "string" - }, - { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" } ] }, @@ -115119,12 +123531,11 @@ "name": "createPrivateGateway", "params": [ { - "description": "the Physical Network ID the network belongs to", + "description": "when true bypasses VLAN id/range overlap check during private gateway creation", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "bypassvlanoverlapcheck", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "The isolated network this private gateway is associated to.", @@ -115136,26 +123547,33 @@ "type": "uuid" }, { - "description": "the ID of the network ACL", + "description": "the network implementation uri for the private gateway", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "vlan", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "when true bypasses VLAN id/range overlap check during private gateway creation", + "description": "the gateway of the Private gateway", "length": 255, - "name": "bypassvlanoverlapcheck", + "name": "gateway", + "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": "boolean" + "type": "uuid" }, { - "description": "the network implementation uri for 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": "vlan", + "name": "sourcenatsupported", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the netmask of the Private gateway", @@ -115165,9 +123583,9 @@ "type": "string" }, { - "description": "the uuid of the network offering to use for the private gateways network connection", + "description": "the Physical Network ID the network belongs to", "length": 255, - "name": "networkofferingid", + "name": "physicalnetworkid", "related": "", "required": false, "type": "uuid" @@ -115179,13 +123597,6 @@ "required": true, "type": "string" }, - { - "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported", - "length": 255, - "name": "sourcenatsupported", - "required": false, - "type": "boolean" - }, { "description": "the VPC network belongs to", "length": 255, @@ -115195,136 +123606,137 @@ "type": "uuid" }, { - "description": "the gateway of the Private gateway", + "description": "the ID of the network ACL", "length": 255, - "name": "gateway", - "required": true, - "type": "string" + "name": "aclid", + "related": "createNetworkACLList", + "required": false, + "type": "uuid" } ], "related": "createPrivateGateway", "response": [ { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "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" }, { - "description": "the project name of the private gateway", - "name": "project", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "the id of the private gateway", + "name": "id", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the private gateway's netmask", - "name": "netmask", - "type": "string" + "description": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" }, - {}, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, - {}, { - "description": "the id of the private gateway", - "name": "id", + "description": "the gateway", + "name": "gateway", "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VPC name the private gateway belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "zone id of the private gateway", + "name": "zoneid", "type": "string" }, { - "description": "the gateway", - "name": "gateway", + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, + {}, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, { - "description": "Souce Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" + "description": "the private gateway's ip address", + "name": "ipaddress", + "type": "string" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.17.0" @@ -115344,26 +123756,11 @@ ], "related": "", "response": [ - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, { "description": "the type of the role", "name": "roletype", "type": "string" }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, { "description": "the user ID", "name": "id", @@ -115375,39 +123772,69 @@ "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the domain name of the user", + "name": "domain", "type": "string" }, + {}, { "description": "the date and time the user account was created", "name": "created", "type": "date" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" }, { "description": "the ID of the role", "name": "roleid", "type": "string" }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, { "description": "the boolean value representing if the updating target is in caller's child domain", "name": "iscallerchilddomain", "type": "boolean" }, - {}, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { @@ -115416,54 +123843,49 @@ "type": "resourceiconresponse" }, { - "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 secret key of the user", - "name": "secretkey", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, - {}, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user name", + "name": "username", "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 state", - "name": "state", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, + {}, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the user name", - "name": "username", + "description": "the user lastname", + "name": "lastname", "type": "string" } ] @@ -115474,47 +123896,47 @@ "name": "listLoadBalancerRules", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list by network ID the rule belongs to", "length": 255, - "name": "account", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, - "type": "string" + "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": "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 virtual machine of the load balancer rule", + "description": "list objects by project; if projectid=-1 lists All VMs", "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", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "list by network ID the rule belongs to", + "description": "the public IP address ID of the load balancer rule", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, @@ -115535,41 +123957,11 @@ "type": "uuid" }, { - "description": "the name of the load balancer rule", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "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": "", @@ -115587,79 +123979,48 @@ "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the name of the load balancer rule", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" - } - ], - "related": "", - "response": [ - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", "type": "string" }, { - "description": "the load balancer rule ID", + "description": "the ID of the load balancer rule", + "length": 255, "name": "id", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - {}, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the load balancer", - "name": "name", - "type": "string" + "description": "the ID of the virtual machine of the load balancer rule", + "length": 255, + "name": "virtualmachineid", + "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": false, + "type": "uuid" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + } + ], + "related": "", + "response": [ + { + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -115668,101 +124029,162 @@ "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 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 private port", - "name": "privateport", + "description": "the description of the load balancer", + "name": "description", "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 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": "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": "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, { "description": "the load balancer algorithm (source, roundrobin, leastconn)", "name": "algorithm", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the 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": "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 description of the load balancer", - "name": "description", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -115782,17 +124204,17 @@ } ], "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, {}, { "description": "true if operation is executed successfully", @@ -115811,6 +124233,13 @@ "isasync": false, "name": "uploadSslCert", "params": [ + { + "description": "Private key", + "length": 16384, + "name": "privatekey", + "required": true, + "type": "string" + }, { "description": "Password for the private key", "length": 255, @@ -115819,10 +124248,26 @@ "type": "string" }, { - "description": "account that will own the SSL certificate", + "description": "an optional project for the SSL certificate", "length": 255, - "name": "account", + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "domain ID of the account owning the SSL certificate", + "length": 255, + "name": "domainid", + "related": "listDomains", "required": false, + "type": "uuid" + }, + { + "description": "Name for the uploaded certificate", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { @@ -115834,10 +124279,10 @@ "type": "boolean" }, { - "description": "Name for the uploaded certificate", + "description": "account that will own the SSL certificate", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { @@ -115847,105 +124292,82 @@ "required": true, "type": "string" }, - { - "description": "Private key", - "length": 16384, - "name": "privatekey", - "required": true, - "type": "string" - }, - { - "description": "domain ID of the account owning the SSL certificate", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, { "description": "Certificate chain of trust", "length": 2097152, "name": "certchain", "required": false, "type": "string" - }, - { - "description": "an optional project for the SSL certificate", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "", "response": [ { - "description": "name", - "name": "name", + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "certificate fingerprint", "name": "fingerprint", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the certificate", + "name": "project", + "type": "string" + }, + { + "description": "certificate chain", + "name": "certchain", + "type": "string" }, { "description": "the domain id of the network owner", "name": "domainid", "type": "string" }, - {}, { - "description": "account for the certificate", - "name": "account", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the project name of the certificate", - "name": "project", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, + {}, { "description": "List of loabalancers this certificate is bound to", "name": "loadbalancerrulelist", "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project id of the certificate", - "name": "projectid", + "description": "name", + "name": "name", "type": "string" }, { - "description": "SSL certificate ID", - "name": "id", + "description": "account for the certificate", + "name": "account", "type": "string" }, { "description": "certificate", "name": "certificate", "type": "string" - }, - { - "description": "certificate chain", - "name": "certchain", - "type": "string" } ] }, @@ -115955,11 +124377,25 @@ "name": "createVpnCustomerGateway", "params": [ { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "ipsecpsk", - "required": true, - "type": "string" + "name": "esplifetime", + "required": false, + "type": "long" + }, + { + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "length": 255, + "name": "ikelifetime", + "required": false, + "type": "long" + }, + { + "description": "Force Encapsulation for NAT traversal", + "length": 255, + "name": "forceencap", + "required": false, + "type": "boolean" }, { "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", @@ -115970,18 +124406,18 @@ "type": "boolean" }, { - "description": "public ip address id of the customer gateway", + "description": "ESP policy of the customer gateway", "length": 255, - "name": "gateway", + "name": "esppolicy", "required": true, "type": "string" }, { - "description": "Force Encapsulation for NAT traversal", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", "length": 255, - "name": "forceencap", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "IKE policy of the customer gateway", @@ -115991,18 +124427,18 @@ "type": "string" }, { - "description": "name of this customer gateway", + "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "name", - "required": false, + "name": "cidrlist", + "required": true, "type": "string" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "esplifetime", + "name": "dpd", "required": false, - "type": "long" + "type": "boolean" }, { "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", @@ -116012,6 +124448,13 @@ "since": "4.15.1", "type": "string" }, + { + "description": "name of this customer gateway", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", "length": 255, @@ -116030,46 +124473,25 @@ "type": "uuid" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", - "length": 255, - "name": "ikelifetime", - "required": false, - "type": "long" - }, - { - "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "public ip address id of the customer gateway", "length": 255, - "name": "cidrlist", + "name": "gateway", "required": true, "type": "string" }, { - "description": "ESP policy of the customer gateway", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "esppolicy", + "name": "ipsecpsk", "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": "If DPD is enabled for VPN connection", - "length": 255, - "name": "dpd", - "required": false, - "type": "boolean" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the owner", + "name": "account", "type": "string" }, { @@ -116078,19 +124500,19 @@ "type": "long" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { "description": "IPsec preshared-key of customer gateway", @@ -116098,23 +124520,18 @@ "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the project name", + "name": "project", "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 ip of the customer gateway", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { @@ -116123,40 +124540,45 @@ "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the owner", - "name": "account", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the vpn gateway ID", + "name": "id", + "type": "string" }, { "description": "the date and time the host was removed", @@ -116164,25 +124586,25 @@ "type": "date" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, + {}, { - "description": "the project id", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the vpn gateway ID", - "name": "id", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id", + "name": "projectid", + "type": "string" } ] }, @@ -116192,17 +124614,17 @@ "name": "createManagementNetworkIpRange", "params": [ { - "description": "The gateway for the management network.", + "description": "The starting IP address.", "length": 255, - "name": "gateway", + "name": "startip", "required": true, "type": "string" }, { - "description": "The starting IP address.", + "description": "The ending IP address.", "length": 255, - "name": "startip", - "required": true, + "name": "endip", + "required": false, "type": "string" }, { @@ -116220,14 +124642,7 @@ "type": "string" }, { - "description": "The ending IP address.", - "length": 255, - "name": "endip", - "required": false, - "type": "string" - }, - { - "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means you network is not on any Vlan", + "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, @@ -116240,148 +124655,140 @@ "related": "createManagementNetworkIpRange", "required": true, "type": "uuid" + }, + { + "description": "The gateway for the management network.", + "length": 255, + "name": "gateway", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ { - "description": "the Zone name", - "name": "zonename", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" } ], "type": "list" }, - {}, - { - "description": "the ID of the Pod", - "name": "id", - "type": "string" - }, - { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - { - "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 IP ranges for the Pod", - "name": "ipranges", + "description": "the capacity of the Pod", + "name": "capacity", "response": [ { - "description": "the gateway for the range", - "name": "gateway", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" } ], "type": "list" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { @@ -116390,8 +124797,8 @@ "type": "integer" }, { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", "type": "list" }, { @@ -116400,25 +124807,40 @@ "type": "string" }, { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the Pod", - "name": "name", + "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 name of the Pod", + "name": "zonename", + "type": "string" + }, + { + "description": "the gateway of the Pod", + "name": "gateway", + "type": "string" + }, + { + "description": "the name of the Pod", + "name": "name", + "type": "string" } ], "since": "4.11.0.0" @@ -116429,12 +124851,11 @@ "name": "listCiscoNexusVSMs", "params": [ { - "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -116446,41 +124867,52 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "clusterid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "page", + "name": "clusterid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ + { + "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 VSM is a switch supervisor. This is the VSM's switch domain id", "name": "vsmdomainid", "type": "string" }, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", - "type": "string" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "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" }, { @@ -116488,30 +124920,31 @@ "name": "vsmconfigmode", "type": "string" }, + {}, { - "description": "device state", - "name": "vsmdevicestate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", + "type": "string" }, - {}, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, { @@ -116519,26 +124952,15 @@ "name": "vsmconfigstate", "type": "string" }, - {}, - { - "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 name", - "name": "vsmdevicename", + "description": "device state", + "name": "vsmdevicestate", "type": "string" - }, - { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" } ] }, @@ -116547,14 +124969,6 @@ "isasync": true, "name": "addVpnUser", "params": [ - { - "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, { "description": "add vpn user to the specific project", "length": 255, @@ -116564,9 +124978,9 @@ "type": "uuid" }, { - "description": "username for the vpn user", + "description": "password for the username", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, @@ -116578,25 +124992,42 @@ "type": "string" }, { - "description": "password for the username", + "description": "username for the vpn user", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" + }, + { + "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "the vpn userID", - "name": "id", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, {}, { - "description": "the username of the vpn user", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { @@ -116605,13 +125036,14 @@ "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the username of the vpn user", + "name": "username", "type": "string" }, + {}, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { @@ -116620,26 +125052,96 @@ "type": "integer" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the vpn userID", + "name": "id", "type": "string" }, { "description": "the state of the Vpn User", "name": "state", "type": "string" + } + ] + }, + { + "description": "remove an annotation.", + "isasync": false, + "name": "removeAnnotation", + "params": [ + { + "description": "the id of the annotation", + "length": 255, + "name": "id", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, + {}, { - "description": "the project name of the vpn", - "name": "project", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", + "type": "string" + }, + { + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" + }, + { + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + { + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" + }, + { + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the (uu)id of the annotation", + "name": "id", + "type": "string" + }, + { + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" + }, + { + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of the annotated entity", + "name": "entitytype", + "type": "string" } - ] + ], + "since": "4.11" }, { "description": "add a baremetal host", @@ -116647,10 +125149,25 @@ "name": "addBaremetalHost", "params": [ { - "description": "the host URL", + "description": "the cluster name for the host", "length": 255, - "name": "url", + "name": "clustername", + "required": false, + "type": "string" + }, + { + "description": "the Pod ID for the host", + "length": 255, + "name": "podid", + "related": "", "required": true, + "type": "uuid" + }, + { + "description": "ip address intentionally allocated to this host after provisioning", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { @@ -116667,14 +125184,6 @@ "required": false, "type": "list" }, - { - "description": "the Zone ID for the host", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, { "description": "the cluster ID for the host", "length": 255, @@ -116684,11 +125193,12 @@ "type": "uuid" }, { - "description": "ip address intentionally allocated to this host after provisioning", + "description": "the Zone ID for the host", "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { "description": "the password for the host; required to be passed for hypervisors other than VMWare", @@ -116705,55 +125215,141 @@ "type": "string" }, { - "description": "the cluster name for the host", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "clustername", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the Pod ID for the host", + "description": "the host URL", "length": 255, - "name": "podid", - "related": "", + "name": "url", "required": true, - "type": "uuid" - }, - { - "description": "Allocation state of this Host for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, "type": "string" } ], "related": "", "response": [ + { + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, + { + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, { "description": "the amount of the host's memory currently allocated", "name": "memoryallocated", "type": "long" }, - {}, + { + "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 OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "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 CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "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 supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "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": "hypervisortype" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { "description": "the Pod ID of the host", @@ -116761,158 +125357,160 @@ "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, { "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", "name": "memorytotal", "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, + {}, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the 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 cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the name of the host", - "name": "name", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "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 used", - "name": "memoryused", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the name of the host", + "name": "name", "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": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "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 number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "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": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", "name": "remainingcapacity", "type": "long" }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, { "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", "name": "maxcapacity", @@ -116924,8 +125522,8 @@ "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { @@ -116934,243 +125532,72 @@ "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "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 created", - "name": "created", - "type": "date" - }, - { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" - }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, - { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, { "description": "Host details in key/value pairs.", "name": "details", "type": "map" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - {}, { "description": "the CPU number of the host", "name": "cpunumber", "type": "integer" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - } - ] - }, - { - "description": "remove an annotation.", - "isasync": false, - "name": "removeAnnotation", - "params": [ - { - "description": "the id of the annotation", - "length": 255, - "name": "id", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the contents of the annotation", - "name": "annotation", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the (uu)id of the entitiy to which this annotation pertains", - "name": "entityid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the name of the entitiy to which this annotation pertains", - "name": "entityname", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" } - ], - "since": "4.11" + ] }, { "description": "Deletes a project role permission in the project", @@ -117196,27 +125623,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" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.15.0" }, @@ -117235,30 +125662,113 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "Lists all configuration groups (primarily used for UI).", + "isasync": false, + "name": "listConfigurationGroups", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, + { + "description": "lists configuration group by group name", + "length": 255, + "name": "group", + "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 precedence of the configuration group", + "name": "precedence", + "type": "long" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the subgroups of the configuration group", + "name": "subgroup", + "response": [ + { + "description": "the name of the configuration subgroup", + "name": "name", + "type": "string" + }, + { + "description": "the precedence of the configuration subgroup", + "name": "precedence", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "the name of the configuration group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the configuration group", + "name": "description", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {} ], - "since": "4.9.0" + "since": "4.18.0" }, { "description": "Releases a Pod IP back to the Pod", @@ -117274,28 +125784,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" + }, + {}, + {} ] }, { @@ -117303,6 +125813,13 @@ "isasync": true, "name": "updateVPCOffering", "params": [ + { + "description": "the name of the VPC offering", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "the id of the VPC offering", "length": 255, @@ -117332,13 +125849,6 @@ "required": false, "type": "string" }, - { - "description": "the name of the VPC offering", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, @@ -117357,17 +125867,63 @@ ], "related": "", "response": [ + {}, { "description": "state of the vpc offering. Can be Disabled/Enabled", "name": "state", "type": "string" }, + { + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", + "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 zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "the id of the vpc offering", + "name": "id", + "type": "string" + }, + { + "description": " indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" + }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, { "description": "an alternate display text of the vpc offering.", "name": "displaytext", "type": "string" }, - {}, { "description": "the list of supported services", "name": "service", @@ -117382,9 +125938,9 @@ "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", @@ -117392,9 +125948,9 @@ "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" @@ -117404,8 +125960,8 @@ "name": "provider", "response": [ { - "description": "state of the network provider", - "name": "state", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -117414,29 +125970,29 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "state of the network provider", + "name": "state", "type": "string" }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" } ], "type": "list" @@ -117445,14 +126001,9 @@ "type": "list" }, { - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the name of the vpc offering", @@ -117460,55 +126011,14 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" }, { "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domain", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, - { - "description": "the id of the vpc offering", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" - }, - { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" } ] }, @@ -117544,10 +126054,19 @@ ], "related": "", "response": [ - {}, { - "description": "the project name of the vpn", - "name": "project", + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { @@ -117556,8 +126075,13 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { @@ -117565,19 +126089,31 @@ "name": "id", "type": "string" }, + {}, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { "description": "the account of the remote access vpn", "name": "account", "type": "string" }, + {}, + { + "description": "the ipsec preshared key", + "name": "presharedkey", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -117589,48 +126125,62 @@ "description": "the domain id of the account of the remote access vpn", "name": "domainid", "type": "string" - }, + } + ], + "since": "4.4" + }, + { + "description": "Lists user two factor authenticator providers", + "isasync": false, + "name": "listUserTwoFactorAuthenticatorProviders", + "params": [ { - "description": "the state of the rule", - "name": "state", + "description": "List user two factor authenticator provider by name", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ {}, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the description of the user two factor authenticator provider", + "name": "description", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the user two factor authenticator provider name", + "name": "name", "type": "string" }, + {}, { - "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" } ], - "since": "4.4" + "since": "4.18.0" }, { - "description": "Scales the virtual machine to a new service offering. This command also takes into account the Volume and it may resize the root disk size according to the service offering.", + "description": "Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.", "isasync": true, "name": "scaleVirtualMachine", "params": [ { - "description": "The ID of the virtual machine", + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", "length": 255, - "name": "id", - "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": true, - "type": "uuid" + "name": "automigrate", + "required": false, + "since": "4.17", + "type": "boolean" }, { "description": "New minimum number of IOPS for the custom disk offering", @@ -117649,20 +126199,19 @@ "type": "long" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "details", + "required": false, + "type": "map" }, { - "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "description": "The ID of the virtual machine", "length": 255, - "name": "automigrate", - "required": false, - "since": "4.17", - "type": "boolean" + "name": "id", + "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": true, + "type": "uuid" }, { "description": "Verify OK to Shrink", @@ -117673,36 +126222,37 @@ "type": "boolean" }, { - "description": "name value pairs of custom parameters for cpu,memory and cpunumber. example details[i].name=value", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "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" - }, - {} + } ] }, { @@ -117710,14 +126260,6 @@ "isasync": true, "name": "destroyVirtualMachine", "params": [ - { - "description": "If true is passed, the vm is expunged immediately. False by default.", - "length": 255, - "name": "expunge", - "required": false, - "since": "4.2.1", - "type": "boolean" - }, { "description": "The ID of the virtual machine", "length": 255, @@ -117726,6 +126268,14 @@ "required": true, "type": "uuid" }, + { + "description": "If true is passed, the vm is expunged immediately. False by default.", + "length": 255, + "name": "expunge", + "required": false, + "since": "4.2.1", + "type": "boolean" + }, { "description": "Comma separated list of UUIDs for volumes that will be deleted", "length": 255, @@ -117739,183 +126289,356 @@ "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "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", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, + {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, - {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "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": "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "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": "the account associated with the virtual machine", - "name": "account", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "Guest vm Boot Type", + "name": "boottype", "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": "device type of the root volume", - "name": "rootdevicetype", + "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 pool type of the virtual machine", "name": "pooltype", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the project id of the vm", + "name": "projectid", "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", + "description": "the ID of the disk offering of the virtual machine", + "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "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": "State of the Service from LB rule", - "name": "servicestate", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "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": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -117923,24 +126646,19 @@ "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", + "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" }, { @@ -117952,40 +126670,100 @@ "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" } ], "type": "set" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "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": "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 ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "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 name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { "description": "the write (IO) of disk on the VM", @@ -117993,8 +126771,8 @@ "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { @@ -118002,70 +126780,8 @@ "name": "securitygroup", "response": [ { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the 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": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", "type": "set" }, { @@ -118074,13 +126790,8 @@ "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -118088,57 +126799,52 @@ "name": "project", "type": "string" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the 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 list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -118146,43 +126852,48 @@ "name": "value", "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", + "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" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "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": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { "description": "account owning the security group rule", @@ -118190,22 +126901,22 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the list of egress rules associated with the security group", @@ -118227,8 +126938,8 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -118240,24 +126951,14 @@ "name": "key", "type": "string" }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -118266,132 +126967,194 @@ "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 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", "type": "string" }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the 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": "the id of the security group rule", - "name": "ruleid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "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 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" } ], "type": "set" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "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 virtual machine", - "name": "name", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { @@ -118400,195 +127163,38 @@ "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the 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": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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": "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" - }, - { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -118596,29 +127202,24 @@ "name": "affinitygroup", "response": [ { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, { "description": "the project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { "description": "the description of the affinity group", @@ -118631,8 +127232,13 @@ "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { @@ -118641,62 +127247,51 @@ "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "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": "the ID of the virtual machine", - "name": "id", + "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": "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", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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": "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 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 AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" } ] @@ -118733,48 +127328,80 @@ ], "related": "", "response": [ + {}, + {}, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, { "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", "name": "destcidrlist", "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "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" + }, + { + "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": "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 list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -118783,78 +127410,46 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" - }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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 public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "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": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "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" }, { @@ -118863,14 +127458,14 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" } ], "since": "4.4" @@ -118881,33 +127476,33 @@ "name": "listOsCategories", "params": [ { - "description": "", + "description": "list Os category by id", "length": 255, - "name": "page", + "name": "id", + "related": "listOsCategories", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list os category by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, - "since": "3.0.1", "type": "string" }, { - "description": "list Os category by id", + "description": "", "length": 255, - "name": "id", - "related": "listOsCategories", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "list os category by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, + "since": "3.0.1", "type": "string" }, { @@ -118920,27 +127515,27 @@ ], "related": "", "response": [ - {}, - {}, { - "description": "the ID of the OS category", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the OS category", + "name": "name", "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the OS category", - "name": "name", + "description": "the ID of the OS category", + "name": "id", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -118950,11 +127545,20 @@ "name": "listServiceOfferings", "params": [ { - "description": "name of the service offering", + "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": "id of zone disk offering is associated with", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "since": "4.13", + "type": "uuid" }, { "description": "List by keyword", @@ -118972,85 +127576,84 @@ "type": "integer" }, { - "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", + "description": "ID of the service offering", "length": 255, - "name": "systemvmtype", + "name": "id", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the RAM memory that listed offering must support", + "description": "is this a system vm offering", "length": 255, - "name": "memory", + "name": "issystem", "required": false, - "since": "4.15", - "type": "integer" + "type": "boolean" }, { - "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": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", "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", + "name": "systemvmtype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "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": "pagesize", + "name": "virtualmachineid", + "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "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": "name of the service offering", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "listed offerings support root disk encryption", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "encryptroot", "required": false, - "type": "uuid" + "since": "4.18", + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "id of zone disk offering is associated with", + "description": "the RAM memory that listed offering must support", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "memory", "required": false, - "since": "4.13", - "type": "uuid" + "since": "4.15", + "type": "integer" }, { - "description": "ID of the service offering", + "description": "", "length": 255, - "name": "id", - "related": "updateServiceOffering,listServiceOfferings", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "is this a system vm 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": "issystem", + "name": "listall", "required": false, "type": "boolean" }, @@ -119066,34 +127669,24 @@ "related": "updateServiceOffering", "response": [ { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "description": "is this a system vm offering", - "name": "issystem", + "description": "the ha support in the service offering", + "name": "offerha", "type": "boolean" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", - "type": "string" - }, - { - "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": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "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": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { "description": "is true if the offering is customized", @@ -119101,95 +127694,83 @@ "type": "boolean" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "Root disk size in GB", + "name": "rootdisksize", "type": "long" }, - {}, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", - "type": "string" + "description": "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": "Root disk size in GB", - "name": "rootdisksize", + "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "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": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "the name of the service offering", - "name": "name", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the id of the service offering", + "name": "id", "type": "string" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" - }, - { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", + "type": "string" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { @@ -119198,19 +127779,19 @@ "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 disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "the tags for the service offering", + "name": "storagetags", + "type": "string" }, { "description": "the storage type for this service offering", @@ -119218,53 +127799,63 @@ "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" + }, + { + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "the id of the service offering", - "name": "id", + "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": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the host tag for the service offering", + "name": "hosttags", + "type": "string" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", "type": "boolean" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { @@ -119273,59 +127864,76 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "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": "the name of the service offering", + "name": "name", + "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, + {}, + {}, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", + "name": "isvolatile", + "type": "boolean" + }, + { + "description": "is this a system vm offering", + "name": "issystem", + "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 tags for the service offering", - "name": "storagetags", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", "type": "integer" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" + }, + { + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" } ] }, @@ -119335,29 +127943,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": "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", @@ -119368,12 +127970,18 @@ "name": "success", "type": "boolean" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -119381,13 +127989,6 @@ "isasync": false, "name": "listAffinityGroupTypes", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -119401,6 +128002,13 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", @@ -119413,13 +128021,13 @@ {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -119430,19 +128038,19 @@ "name": "listCapacity", "params": [ { - "description": "Sort the results. Available values: Usage", + "description": "", "length": 255, - "name": "sortby", + "name": "page", "required": false, - "since": "3.0.0", - "type": "string" + "type": "integer" }, { - "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": "lists capacity by the Zone ID", "length": 255, - "name": "type", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -119452,11 +128060,20 @@ "type": "string" }, { - "description": "", + "description": "recalculate capacities and fetch the latest", + "length": 255, + "name": "fetchlatest", + "required": false, + "since": "3.0.0", + "type": "boolean" + }, + { + "description": "Sort the results. Available values: Usage", "length": 255, - "name": "page", + "name": "sortby", "required": false, - "type": "integer" + "since": "3.0.0", + "type": "string" }, { "description": "", @@ -119465,14 +128082,6 @@ "required": false, "type": "integer" }, - { - "description": "lists capacity by the Zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, { "description": "lists capacity by the Cluster ID", "length": 255, @@ -119482,14 +128091,6 @@ "since": "3.0.0", "type": "uuid" }, - { - "description": "recalculate capacities and fetch the latest", - "length": 255, - "name": "fetchlatest", - "required": false, - "since": "3.0.0", - "type": "boolean" - }, { "description": "lists capacity by the Pod ID", "length": 255, @@ -119497,54 +128098,51 @@ "related": "", "required": false, "type": "uuid" + }, + { + "description": "lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", + "length": 255, + "name": "type", + "required": false, + "type": "integer" } ], "related": "", "response": [ - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, { "description": "the Zone name", "name": "zonename", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Pod name", + "name": "podname", "type": "string" }, - {}, { "description": "the Cluster name", "name": "clustername", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -119553,26 +128151,36 @@ "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { "description": "the current status of the latest 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 capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" - } + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + {} ] }, { @@ -119581,12 +128189,28 @@ "name": "startVirtualMachine", "params": [ { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "The ID of the virtual machine", "length": 255, - "name": "deploymentplanner", + "name": "id", + "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": true, + "type": "uuid" + }, + { + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "clusterid", + "related": "", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" + }, + { + "description": "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process.", + "length": 255, + "name": "considerlasthost", + "required": false, + "since": "4.18.0", + "type": "boolean" }, { "description": "Boot into hardware setup menu or not", @@ -119597,19 +128221,12 @@ "type": "boolean" }, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "clusterid", + "name": "hostid", "related": "", "required": false, - "type": "uuid" - }, - { - "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", - "required": true, + "since": "3.0.1", "type": "uuid" }, { @@ -119621,41 +128238,54 @@ "type": "uuid" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "hostid", - "related": "", + "name": "deploymentplanner", "required": false, - "since": "3.0.1", - "type": "uuid" + "since": "4.4", + "type": "string" } ], "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "response": [ { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { @@ -119664,19 +128294,194 @@ "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, + {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "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": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { "description": "the name of the ISO attached to the virtual machine", @@ -119684,71 +128489,202 @@ "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, { "description": "the date when this virtual machine was updated last time", "name": "lastupdated", "type": "date" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "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 group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + {}, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "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 name of the security group", + "name": "name", + "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the description of the security group", "name": "description", "type": "string" }, { - "description": "the 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": "id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -119762,19 +128698,14 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" } ], "type": "set" @@ -119784,42 +128715,22 @@ "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 list of ingress rules associated with the security group", "name": "ingressrule", "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -119828,13 +128739,8 @@ "type": "string" }, { - "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" }, { @@ -119848,8 +128754,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -119858,18 +128769,23 @@ "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 domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "security group name", "name": "securitygroupname", @@ -119881,9 +128797,9 @@ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the starting IP of the security group rule", @@ -119891,94 +128807,99 @@ "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": "account owning the security group rule", "name": "account", "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "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" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the 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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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" }, { @@ -119992,93 +128913,68 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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 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 project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "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", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "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", + "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", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { "description": "the state of the virtual machine", @@ -120086,303 +128982,94 @@ "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "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": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - {}, - { - "description": "the 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", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "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 project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { "description": "State of the Service from LB rule", "name": "servicestate", "type": "string" }, + {}, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "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 template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, { "description": "true if high-availability is enabled, false otherwise", "name": "haenable", "type": "boolean" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "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": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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 pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { @@ -120390,33 +129077,23 @@ "name": "nic", "response": [ { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -120425,28 +129102,28 @@ "type": "boolean" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "Id of the 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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -120455,29 +129132,34 @@ "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, { "description": "the IPv6 address of network", "name": "ip6address", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "true if nic is default, false otherwise", @@ -120485,28 +129167,33 @@ "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 traffic type of the nic", - "name": "traffictype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -120515,82 +129202,56 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" } ], "type": "set" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - {}, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" } ] @@ -120601,11 +129262,12 @@ "name": "updateServiceOffering", "params": [ { - "description": "sort key of the service offering, integer", + "description": "the ID of the service offering to be updated", "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" + "name": "id", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" }, { "description": "the name of the service offering to be updated", @@ -120615,28 +129277,19 @@ "type": "string" }, { - "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", + "description": "sort key of the service offering, integer", "length": 255, - "name": "storagetags", + "name": "sortkey", "required": false, - "since": "4.16", - "type": "string" + "type": "integer" }, { - "description": "the display text of the service offering to be updated", - "length": 255, - "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" }, - { - "description": "the ID of the service offering to be updated", - "length": 255, - "name": "id", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" - }, { "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, @@ -120646,62 +129299,85 @@ "type": "string" }, { - "description": "the host tag for this service offering.", + "description": "the display text of the service offering to be updated", "length": 255, - "name": "hosttags", + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", + "length": 255, + "name": "storagetags", "required": false, "since": "4.16", "type": "string" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", + "description": "the host tag for this service offering.", + "length": 255, + "name": "hosttags", "required": false, + "since": "4.16", "type": "string" } ], "related": "", "response": [ { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "the number of CPU", + "name": "cpunumber", "type": "integer" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "the id of the service offering", + "name": "id", + "type": "string" }, { - "description": "the ha support in the service offering", - "name": "offerha", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, + {}, { - "description": "is this a system vm offering", - "name": "issystem", + "description": "the ha support in the service offering", + "name": "offerha", "type": "boolean" }, - {}, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" + }, + { + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, { @@ -120710,13 +129386,23 @@ "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "name of the disk offering", + "name": "diskofferingname", + "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": "data transfer rate in megabits per second allowed.", + "name": "networkrate", "type": "integer" }, { @@ -120725,18 +129411,18 @@ "type": "integer" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", + "description": "is this a default system vm offering", + "name": "defaultuse", "type": "boolean" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "the id of the service offering", - "name": "id", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { @@ -120745,184 +129431,164 @@ "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" - }, - { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "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", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", + "type": "string" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "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 max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "the name of the service offering", + "name": "name", + "type": "string" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "Root disk size in GB", + "name": "rootdisksize", "type": "long" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", "type": "boolean" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "the name of the service offering", - "name": "name", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", + "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 min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, - { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" - }, {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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", - "type": "string" - }, - { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "the storage type for this service offering", - "name": "storagetype", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" } ] @@ -120932,6 +129598,13 @@ "isasync": true, "name": "stopVirtualMachine", "params": [ + { + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). The caller knows the VM is stopped.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, { "description": "The ID of the virtual machine", "length": 255, @@ -120939,31 +129612,33 @@ "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "required": true, "type": "uuid" - }, - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). The caller knows the VM is stopped.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" } ], "related": "scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "response": [ - {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "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": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { @@ -120971,13 +129646,18 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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", "type": "string" }, { @@ -120986,8 +129666,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -120996,144 +129676,48 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the 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 created", - "name": "created", - "type": "date" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "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 user's ID who deployed the virtual machine", - "name": "userid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", @@ -121144,86 +129728,91 @@ "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", + "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", + "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", "type": "integer" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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": "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": "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": "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 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": "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" } ], @@ -121235,57 +129824,87 @@ "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" } ], "type": "set" }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the 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 number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", "type": "integer" }, { - "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 ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the type of the ICMP message response", "name": "icmptype", @@ -121296,38 +129915,23 @@ "name": "startport", "type": "integer" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -121336,28 +129940,28 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -121366,33 +129970,28 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" - }, - { - "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", + "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" }, { @@ -121401,8 +130000,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -121411,13 +130010,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -121426,70 +130020,167 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "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": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the 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 name of the affinity group", "name": "name", "type": "string" }, { - "description": "the domain name of the security group", + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "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 security group", - "name": "id", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "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 name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", @@ -121497,204 +130188,213 @@ "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": "the name of the host for the virtual machine", - "name": "hostname", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Guest vm Boot Mode", + "name": "bootmode", "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 vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "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": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "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 type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - } - ], - "type": "set" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, + {}, { - "description": "OS type id of the vm", - "name": "ostypeid", + "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", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the state of the virtual machine", + "name": "state", "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the ID of the nic", - "name": "id", + "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", + "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 type of the nic", + "name": "type", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -121703,48 +130403,38 @@ "type": "boolean" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the gateway of the nic", + "name": "gateway", "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": "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 netmask of the nic", - "name": "netmask", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -121753,33 +130443,33 @@ "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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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 vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -121787,24 +130477,19 @@ "name": "ip6cidr", "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -121813,102 +130498,128 @@ "type": "list" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" } ], "type": "set" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, - {}, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "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": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, + {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "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", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + {}, { - "description": "the 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 speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "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": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" } ] @@ -121918,14 +130629,6 @@ "isasync": true, "name": "createNetworkACLList", "params": [ - { - "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": "Name of the network ACL list", "length": 255, @@ -121933,6 +130636,14 @@ "required": true, "type": "string" }, + { + "description": "ID of the VPC associated with this network ACL list", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": true, + "type": "uuid" + }, { "description": "Description of the network ACL list", "length": 255, @@ -121941,60 +130652,60 @@ "type": "string" }, { - "description": "ID of the VPC associated with this network ACL list", + "description": "an optional field, whether to the display the list to the end user or not", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "", "response": [ { - "description": "the ID of the ACL", - "name": "id", + "description": "the Name of the ACL", + "name": "name", "type": "string" }, + {}, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "the ID of the ACL", + "name": "id", "type": "string" }, - {}, { "description": "Name of the VPC this ACL is associated with", "name": "vpcname", "type": "string" }, { - "description": "the Name of the ACL", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "Description of the ACL", + "name": "description", + "type": "string" + }, { "description": "is ACL for display to the regular user", "name": "fordisplay", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Description of the ACL", - "name": "description", + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", "type": "string" } ] } ], - "count": 650 + "count": 705 } diff --git a/test/AutoScaleService_test.go b/test/AutoScaleService_test.go index 18d48a3d..9105c429 100644 --- a/test/AutoScaleService_test.go +++ b/test/AutoScaleService_test.go @@ -99,7 +99,7 @@ func TestAutoScaleService(t *testing.T) { if _, ok := response["createCounter"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.AutoScale.NewCreateCounterParams("name", "source", "value") + p := client.AutoScale.NewCreateCounterParams("name", "provider", "source", "value") r, err := client.AutoScale.CreateCounter(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/NetworkService_test.go b/test/NetworkService_test.go index 4e408c04..1bff3c27 100644 --- a/test/NetworkService_test.go +++ b/test/NetworkService_test.go @@ -69,7 +69,7 @@ func TestNetworkService(t *testing.T) { if _, ok := response["createNetwork"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.Network.NewCreateNetworkParams("displaytext", "name", "networkofferingid", "zoneid") + p := client.Network.NewCreateNetworkParams("name", "networkofferingid", "zoneid") r, err := client.Network.CreateNetwork(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/PodService_test.go b/test/PodService_test.go index 56b923a6..9e58ed5a 100644 --- a/test/PodService_test.go +++ b/test/PodService_test.go @@ -39,7 +39,7 @@ func TestPodService(t *testing.T) { if _, ok := response["createPod"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.Pod.NewCreatePodParams("gateway", "name", "netmask", "startip", "zoneid") + p := client.Pod.NewCreatePodParams("name", "zoneid") r, err := client.Pod.CreatePod(p) if err != nil { t.Errorf(err.Error())